cf-service-sdk

TypeScript SDK for the CloudForge Service, built with Apollo Client and GraphQL.

Installation

npm install cf-service-sdk

Development

Prerequisites

• Node.js
• The cf-service Django backend checked out as a sibling directory (../cf-service)
• Django virtual environment at ../cf-service/venv

Local Development Workflow

Use update-local.sh to pull the latest schema from the Django backend, regenerate all SDK files, build, and install the package directly into cf-web — all in one step.

./update-local.sh

This script will:

1. Clean the dist directory and remove old generated schema/documents
2. Pull the latest GraphQL schema from the Django backend (npm run update-schema)
3. Run GraphQL codegen to regenerate TypeScript types (npm run generate)
4. Run SDK codegen (npm run generate-sdk)
5. Install dependencies
6. Build the package
7. Pack and install it directly into ../cf-web

Note: Both cf-service and cf-web must be checked out as sibling directories alongside this repo.

Publishing to npm

Use publish.sh to build and publish a new version to npm.

./publish.sh

This script will:

1. Verify you are logged in to npm (run npm login first if not)
2. Clean and regenerate all schema, documents, and SDK files
3. Check whether the current version in package.json already exists on npm
4. If it does, prompt you to bump the version (patch / minor / major)
5. Confirm before publishing
6. Publish the package with npm publish --access public

npm Scripts

| Script | Description | |---|---| | npm run update-schema | Pull GraphQL schema from Django and generate .graphql files | | npm run generate | Run GraphQL codegen to produce TypeScript types | | npm run generate-sdk | Generate the TypeScript SDK from GraphQL operations | | npm run build | Compile TypeScript to dist/ |