@cloudcannon/sdk 0.0.1 → 0.0.2

package/dist/index.d.ts

@@ -1,9 +1,13 @@
 import type { components, operations, paths } from './schema.ts';
+import { BuildClient } from './src/build.ts';
+import { type CommitEditingSessionOptions, type CommitEditingSessionResponse, EditingSessionClient } from './src/editing-session.ts';
+import { EditingSessionFileClient } from './src/editing-session-file.ts';
 import { InboxClient } from './src/inbox.ts';
 import { OrgClient } from './src/org.ts';
 import { type BuildConfiguration, SiteClient } from './src/site.ts';
 import { SiteInboxClient } from './src/site-inbox.ts';
-export type { BuildConfiguration };
+import { SyncClient } from './src/sync.ts';
+export type { BuildConfiguration, CommitEditingSessionOptions, CommitEditingSessionResponse };
 export type Provider = operations['Providers_Repositories']['parameters']['path']['provider'];
 export type Site = components['schemas']['SiteBlueprint'];
 export type Org = components['schemas']['OrgBlueprintFull'];
@@ -15,6 +19,10 @@ export type SiteDam = components['schemas']['SiteDamBlueprint'];
 export type FormSubmission = components['schemas']['FormHookBlueprint'];
 export type Inbox = components['schemas']['InboxBlueprint'];
 export type Dam = components['schemas']['DamBlueprint'];
+export type EditingSession = components['schemas']['EditingSessionBlueprint'];
+export type EditingSessionFile = components['schemas']['EditingSessionFileBlueprint'];
+export type EditingSessionFileContribution = components['schemas']['EditingSessionFileContributionBlueprint'];
+export type UploadData = operations['Index_UploadData']['responses']['200']['content']['application/json'];
 export type ProviderDetails = {
     provider: Provider;
     repository: string;
@@ -73,5 +81,10 @@ export default class CloudCannonClient {
     site(uuid: string): SiteClient;
     inbox(uuid: string): InboxClient;
     siteInbox(uuid: string): SiteInboxClient;
+    editingSession(uuid: string): EditingSessionClient;
+    editingSessionFile(uuid: string): EditingSessionFileClient;
+    build(uuid: string): BuildClient;
+    sync(uuid: string): SyncClient;
     orgs(): Promise<Org[]>;
+    getUploadData(): Promise<UploadData>;
 }

package/dist/index.js

@@ -1,7 +1,11 @@
+import { BuildClient } from "./src/build.js";
+import { EditingSessionClient, } from "./src/editing-session.js";
+import { EditingSessionFileClient } from "./src/editing-session-file.js";
 import { InboxClient } from "./src/inbox.js";
 import { OrgClient } from "./src/org.js";
 import { SiteClient } from "./src/site.js";
 import { SiteInboxClient } from "./src/site-inbox.js";
+import { SyncClient } from "./src/sync.js";
 export default class CloudCannonClient {
     #apiKey;
     #appDomain;
@@ -52,9 +56,32 @@ export default class CloudCannonClient {
     siteInbox(uuid) {
         return new SiteInboxClient(uuid, this);
     }
+    editingSession(uuid) {
+        return new EditingSessionClient(uuid, this);
+    }
+    editingSessionFile(uuid) {
+        return new EditingSessionFileClient(uuid, this);
+    }
+    build(uuid) {
+        return new BuildClient(uuid, this);
+    }
+    sync(uuid) {
+        return new SyncClient(uuid, this);
+    }
     async orgs() {
         const resp = await this.fetch('/orgs');
         const orgs = await resp.json();
         return orgs;
     }
+    async getUploadData() {
+        const resp = await this.fetch('/upload-data');
+        if (resp.status === 403) {
+            throw new Error('Error fetching upload data. Permission denied');
+        }
+        if (resp.status === 422) {
+            throw new Error('Error fetching upload data. Invalid request');
+        }
+        const uploadData = await resp.json();
+        return uploadData;
+    }
 }

package/dist/schema.d.ts

@@ -2202,6 +2202,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    '/api/v0/upload-data': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Get the presigned data for file upload */
+        get: operations['Index_UploadData'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/api/v0/users': {
         parameters: {
             query?: never;
@@ -3841,7 +3858,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    'application/json': components['schemas']['EditingSessionFileBlueprint'][];
+                    'application/json': components['schemas']['EditingSessionFileContributionBlueprint'][];
                 };
             };
             403: components['responses']['ForbiddenResp'];
@@ -3859,9 +3876,9 @@ export interface operations {
         requestBody: {
             content: {
                 'application/json': {
-                    s3_key?: Record<string, never>;
+                    s3_key: string;
                     content_hash: string;
-                    previous_content_hash?: Record<string, never>;
+                    previous_content_hash?: string;
                 };
             };
         };
@@ -4039,7 +4056,13 @@ export interface operations {
             };
             cookie?: never;
         };
-        requestBody?: never;
+        requestBody: {
+            content: {
+                'application/json': {
+                    previous_content_hash: string;
+                };
+            };
+        };
         responses: {
             /** @description Created */
             200: {
@@ -4257,8 +4280,8 @@ export interface operations {
                     edit_type?: string | null;
                     path?: string | null;
                     source_path?: string | null;
-                    discard_unsaved?: Record<string, never>;
-                    previous_content_hash?: Record<string, never>;
+                    discard_unsaved?: boolean;
+                    previous_content_hash?: string;
                     metadata?: {
                         [key: string]: unknown;
                     };
@@ -4266,6 +4289,15 @@ export interface operations {
             };
         };
         responses: {
+            /** @description Success */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['EditingSessionFileBlueprint'];
+                };
+            };
             /** @description Created */
             201: {
                 headers: {
@@ -8613,6 +8645,34 @@ export interface operations {
             403: components['responses']['ForbiddenResp'];
         };
     };
+    Index_UploadData: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        prefix: string;
+                        url: string;
+                        fields: {
+                            [key: string]: string;
+                        };
+                    };
+                };
+            };
+            403: components['responses']['ForbiddenResp'];
+            422: components['responses']['ErrorResp'];
+        };
+    };
     Users_ShowCurrentUser: {
         parameters: {
             query?: never;

package/dist/src/build.d.ts

@@ -0,0 +1,6 @@
+import type CloudCannonClient from '../index.ts';
+export declare class BuildClient {
+    #private;
+    constructor(uuid: string, client: CloudCannonClient);
+    get(): Promise<Response>;
+}

package/dist/src/build.js

@@ -0,0 +1,15 @@
+export class BuildClient {
+    #uuid;
+    #client;
+    constructor(uuid, client) {
+        this.#uuid = uuid;
+        this.#client = client;
+    }
+    async get() {
+        const resp = await this.#client.fetch(`/builds/${this.#uuid}`);
+        if (resp.status === 401 || resp.status === 403) {
+            throw new Error('Error fetching build. Permission denied');
+        }
+        return resp;
+    }
+}

package/dist/src/editing-session-file.d.ts

@@ -0,0 +1,13 @@
+import type CloudCannonClient from '../index.ts';
+import type { EditingSessionFile, EditingSessionFileContribution } from '../index.ts';
+import type { operations } from '../schema.js';
+export type CreateContributionOptions = operations['Editing Session Contributions_Create']['requestBody']['content']['application/json'];
+export type UnlockOptions = operations['Editing Session File_Unlock']['requestBody']['content']['application/json'];
+export declare class EditingSessionFileClient {
+    #private;
+    constructor(uuid: string, client: CloudCannonClient);
+    get(): Promise<EditingSessionFile>;
+    getContributions(): Promise<EditingSessionFileContribution[]>;
+    createContribution(body: CreateContributionOptions): Promise<EditingSessionFileContribution>;
+    unlock(body: UnlockOptions): Promise<EditingSessionFileContribution>;
+}

package/dist/src/editing-session-file.js

@@ -0,0 +1,58 @@
+import { ApiError } from "./errors.js";
+export class EditingSessionFileClient {
+    #uuid;
+    #client;
+    constructor(uuid, client) {
+        this.#uuid = uuid;
+        this.#client = client;
+    }
+    async get() {
+        const resp = await this.#client.fetch(`/editing_session_files/${this.#uuid}`);
+        if (resp.status === 403) {
+            throw new Error('Error fetching editing session file. Permission denied');
+        }
+        const file = await resp.json();
+        return file;
+    }
+    async getContributions() {
+        const resp = await this.#client.fetch(`/editing_session_files/${this.#uuid}/contributions`);
+        if (resp.status === 403) {
+            throw new Error('Error fetching editing session file contributions. Permission denied');
+        }
+        const contributions = await resp.json();
+        return contributions;
+    }
+    async createContribution(body) {
+        const resp = await this.#client.fetch(`/editing_session_files/${this.#uuid}/contributions`, {
+            method: 'POST',
+            body,
+        });
+        if (resp.status === 401 || resp.status === 403) {
+            throw new Error('Error creating editing session file contribution. Permission denied');
+        }
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error creating editing session file contribution. Invalid request', errorResp.errors, `/editing_session_files/${this.#uuid}/contributions`, { method: 'POST', body }, resp.status);
+        }
+        const contribution = await resp.json();
+        return contribution;
+    }
+    async unlock(body) {
+        const resp = await this.#client.fetch(`/editing_session_files/${this.#uuid}/unlock`, {
+            method: 'PUT',
+            body,
+        });
+        if (resp.status === 403) {
+            throw new Error('Error unlocking editing session file. Permission denied');
+        }
+        if (resp.status === 404) {
+            throw new Error('Error unlocking editing session file. File not found');
+        }
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error unlocking editing session file. Invalid request', errorResp.errors, `/editing_session_files/${this.#uuid}/unlock`, { method: 'PUT', body }, resp.status);
+        }
+        const contribution = await resp.json();
+        return contribution;
+    }
+}

package/dist/src/editing-session.d.ts

@@ -0,0 +1,14 @@
+import type CloudCannonClient from '../index.ts';
+import type { EditingSession, EditingSessionFile } from '../index.ts';
+import type { operations } from '../schema.js';
+export type CreateEditingSessionFileOptions = operations['Editing Session Files_Create']['requestBody']['content']['application/json'];
+export type CommitEditingSessionOptions = operations['Editing Session_Commit']['requestBody']['content']['application/json'];
+export type CommitEditingSessionResponse = operations['Editing Session_Commit']['responses']['200']['content']['application/json'];
+export declare class EditingSessionClient {
+    #private;
+    constructor(uuid: string, client: CloudCannonClient);
+    get(): Promise<EditingSession>;
+    getFiles(): Promise<EditingSessionFile[]>;
+    createFile(body: CreateEditingSessionFileOptions): Promise<EditingSessionFile>;
+    commit(): Promise<CommitEditingSessionResponse>;
+}

package/dist/src/editing-session.js

@@ -0,0 +1,54 @@
+import { ApiError } from "./errors.js";
+export class EditingSessionClient {
+    #uuid;
+    #client;
+    constructor(uuid, client) {
+        this.#uuid = uuid;
+        this.#client = client;
+    }
+    async get() {
+        const resp = await this.#client.fetch(`/editing_sessions/${this.#uuid}`);
+        if (resp.status === 403) {
+            throw new Error('Error fetching editing session. Permission denied');
+        }
+        const editingSession = await resp.json();
+        return editingSession;
+    }
+    async getFiles() {
+        const resp = await this.#client.fetch(`/editing_sessions/${this.#uuid}/files`);
+        if (resp.status === 403) {
+            throw new Error('Error fetching editing session files. Permission denied');
+        }
+        const files = await resp.json();
+        return files;
+    }
+    async createFile(body) {
+        const resp = await this.#client.fetch(`/editing_sessions/${this.#uuid}/files`, {
+            method: 'POST',
+            body,
+        });
+        if (resp.status === 403) {
+            throw new Error('Error creating editing session file. Permission denied');
+        }
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error creating editing session file. Invalid request', errorResp.errors, `/editing_sessions/${this.#uuid}/files`, { method: 'POST', body }, resp.status);
+        }
+        const file = await resp.json();
+        return file;
+    }
+    async commit() {
+        const resp = await this.#client.fetch(`/editing_sessions/${this.#uuid}/commit`, {
+            method: 'POST',
+        });
+        if (resp.status === 403) {
+            throw new Error('Error committing editing session. Permission denied');
+        }
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error committing editing session. Invalid request', errorResp.errors, `/editing_sessions/${this.#uuid}/commit`, { method: 'POST' }, resp.status);
+        }
+        const result = await resp.json();
+        return result;
+    }
+}

package/dist/src/site.d.ts

@@ -1,5 +1,5 @@
 import type CloudCannonClient from '../index.ts';
-import type { Build, ProviderDetails, Site, SiteDam, SiteInbox, SiteScan, Sync } from '../index.ts';
+import type { Build, EditingSession, ProviderDetails, Site, SiteDam, SiteInbox, SiteScan, Sync } from '../index.ts';
 import type { operations } from '../schema.js';
 export type BuildConfiguration = Partial<Omit<operations['Sites_UpdateBuild']['requestBody']['content']['application/json'], 'build_configuration'>> & {
     compile?: {
@@ -24,6 +24,11 @@ export type UpdateSiteOptions = operations['Sites_Update']['requestBody']['conte
 export type CopySiteOptions = operations['Sites_Copy']['requestBody']['content']['application/json'];
 export type ConnectInboxOptions = operations['Site Inboxes_Create']['requestBody']['content']['application/json'];
 export type ConnectDamOptions = operations['Dams_Create']['requestBody']['content']['application/json'];
+export type FileListing = operations['Files_Index']['responses']['200']['content']['application/json'][number];
+export type UploadFileOptions = {
+    type?: string;
+    overwriteExistingFile?: boolean;
+};
 export declare class SiteClient {
     #private;
     constructor(uuid: string, client: CloudCannonClient);
@@ -34,6 +39,7 @@ export declare class SiteClient {
     updateBuildConfig(options: BuildConfiguration): Promise<Site>;
     getBuilds(): Promise<Build[]>;
     rebuild(): Promise<void>;
+    listFiles(): Promise<FileListing[]>;
     getFile(path: string): Promise<Response>;
     getSyncs(): Promise<Sync[]>;
     getScan(): Promise<SiteScan>;
@@ -48,4 +54,8 @@ export declare class SiteClient {
     connectInbox(body: ConnectInboxOptions): Promise<SiteInbox>;
     getDamConnections(): Promise<SiteDam[]>;
     connectDam(body: ConnectDamOptions): Promise<SiteDam>;
+    getEditingSessions(): Promise<EditingSession[]>;
+    createEditingSession(): Promise<EditingSession>;
+    getLatestEditingSession(): Promise<EditingSession>;
+    uploadFile(path: string, content: BlobPart, options?: UploadFileOptions): Promise<void>;
 }

package/dist/src/site.js

@@ -86,6 +86,18 @@ export class SiteClient {
             throw new Error('Error creating build. Permission denied');
         }
     }
+    async listFiles() {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/files`);
+        if (resp.status === 401) {
+            throw new Error('Error fetching files. Permission denied');
+        }
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error fetching files. Invalid request', errorResp.errors, `/sites/${this.#uuid}/files`, {}, resp.status);
+        }
+        const files = await resp.json();
+        return files;
+    }
     async getFile(path) {
         const resp = await this.#client.fetch(`/sites/${this.#uuid}/files/${encodeURIComponent(path)}`);
         if (resp.status === 401 || resp.status === 403) {
@@ -251,4 +263,83 @@ export class SiteClient {
         const dam = await resp.json();
         return dam;
     }
+    async getEditingSessions() {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/editing_sessions`);
+        if (resp.status === 403) {
+            throw new Error('Error fetching editing sessions. Permission denied');
+        }
+        const editingSessions = await resp.json();
+        return editingSessions;
+    }
+    async createEditingSession() {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/editing_sessions`, {
+            method: 'POST',
+        });
+        if (resp.status === 401 || resp.status === 403) {
+            throw new Error('Error creating editing session. Permission denied');
+        }
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error creating editing session. Invalid request', errorResp.errors, `/sites/${this.#uuid}/editing_sessions`, { method: 'POST' }, resp.status);
+        }
+        const editingSession = await resp.json();
+        return editingSession;
+    }
+    async getLatestEditingSession() {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/editing_sessions/latest`);
+        if (resp.status === 403) {
+            throw new Error('Error fetching latest editing session. Permission denied');
+        }
+        const editingSession = await resp.json();
+        return editingSession;
+    }
+    async uploadFile(path, content, options = {}) {
+        if (!path.startsWith('/')) {
+            path = `/${path}`;
+        }
+        const files = await this.listFiles();
+        const existingFile = files.find((file) => file.sitePath === path);
+        if (existingFile && !options.overwriteExistingFile) {
+            throw new Error('File already exists and overwriteExistingFile is not set');
+        }
+        const uploadData = await this.#client.getUploadData();
+        const editingSession = await this.createEditingSession();
+        const file = await this.#client.editingSession(editingSession.uuid).createFile({
+            path,
+            source_path: existingFile ? path : undefined,
+            edit_type: 'update',
+        });
+        const contributions = await this.#client.editingSessionFile(file.uuid).getContributions();
+        contributions.sort((a, b) => a.updated_at.localeCompare(b.updated_at));
+        const latestContribution = contributions.at(-1);
+        if (latestContribution && !options.overwriteExistingFile) {
+            throw new Error('File already exists and overwriteExistingFile is not set');
+        }
+        const s3Key = `${uploadData.prefix}/${Date.now()}${path}`;
+        const formData = new FormData();
+        formData.append('key', s3Key);
+        Object.keys(uploadData.fields).forEach((field) => {
+            if (field !== 'key') {
+                formData.append(field, uploadData.fields[field]);
+            }
+        });
+        formData.append('file', new Blob([content], { type: options.type ?? 'text/plain' }));
+        const uploadResp = await fetch(uploadData.url, {
+            method: 'POST',
+            body: formData,
+        });
+        const etag = uploadResp.headers.get('ETag');
+        if (!etag) {
+            throw new Error('ETag not found in upload response');
+        }
+        const contentHash = etag.slice(1, -1);
+        await this.#client.editingSessionFile(file.uuid).createContribution({
+            s3_key: s3Key,
+            content_hash: contentHash,
+            previous_content_hash: latestContribution?.content_hash ?? existingFile?.md5,
+        });
+        await this.#client.editingSessionFile(file.uuid).unlock({
+            previous_content_hash: contentHash,
+        });
+    }
 }

package/dist/src/sync.d.ts

@@ -0,0 +1,6 @@
+import type CloudCannonClient from '../index.ts';
+export declare class SyncClient {
+    #private;
+    constructor(uuid: string, client: CloudCannonClient);
+    get(): Promise<Response>;
+}

package/dist/src/sync.js

@@ -0,0 +1,15 @@
+export class SyncClient {
+    #uuid;
+    #client;
+    constructor(uuid, client) {
+        this.#uuid = uuid;
+        this.#client = client;
+    }
+    async get() {
+        const resp = await this.#client.fetch(`/syncs/${this.#uuid}`);
+        if (resp.status === 401 || resp.status === 403) {
+            throw new Error('Error fetching sync. Permission denied');
+        }
+        return resp;
+    }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloudcannon/sdk",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "REST API client for the CloudCannon CMS.",
   "keywords": [
     "cloudcannon",
@@ -43,7 +43,8 @@
     "test:watch": "node --test --watch",
     "test:coverage": "node --test --test-coverage --test-reporter=lcov --test-reporter-destination=lcov.info",
     "lint": "biome check && tsc --noEmit",
-    "lint:fix": "biome check --fix"
+    "lint:fix": "biome check --fix",
+    "generate-schema": "npx openapi-typescript $1 -o ./schema.ts"
   },
   "author": "CloudCannon <support@cloudcannon.com>",
   "license": "ISC",