@cloudcannon/sdk 0.0.0

package/dist/schema.js

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export {};

package/dist/src/errors.d.ts

@@ -0,0 +1,7 @@
+export declare class ApiError extends Error {
+    errors: unknown;
+    url: string;
+    options: unknown;
+    status: number | null;
+    constructor(message: string, errors: unknown, url: string, options: unknown, status: number | null);
+}

package/dist/src/errors.js

@@ -0,0 +1,13 @@
+export class ApiError extends Error {
+    errors;
+    url;
+    options;
+    status;
+    constructor(message, errors, url, options, status) {
+        super(message);
+        this.errors = errors;
+        this.url = url;
+        this.options = options;
+        this.status = status;
+    }
+}

package/dist/src/inbox.d.ts

@@ -0,0 +1,7 @@
+import type CloudCannonClient from '../index.ts';
+import type { FormSubmission } from '../index.ts';
+export declare class InboxClient {
+    #private;
+    constructor(uuid: string, client: CloudCannonClient);
+    getSubmissions(): Promise<FormSubmission[]>;
+}

package/dist/src/inbox.js

@@ -0,0 +1,16 @@
+export class InboxClient {
+    #uuid;
+    #client;
+    constructor(uuid, client) {
+        this.#uuid = uuid;
+        this.#client = client;
+    }
+    async getSubmissions() {
+        const resp = await this.#client.fetch(`/inboxes/${this.#uuid}/form-hooks`);
+        if (resp.status === 401 || resp.status === 403) {
+            throw new Error('Error fetching submissions. Permission denied');
+        }
+        const submissions = await resp.json();
+        return submissions;
+    }
+}

package/dist/src/org.d.ts

@@ -0,0 +1,22 @@
+import type CloudCannonClient from '../index.ts';
+import type { Dam, Inbox, Org, Provider, ProviderDetails, Site } from '../index.ts';
+import type { operations } from '../schema.js';
+export interface ConnectSiteOptions extends ProviderDetails {
+    folder?: string;
+}
+export type Repository = operations['Providers_Repositories']['responses']['200']['content']['application/json'][number];
+export type CreateInboxOptions = operations['Organization Inboxes_Create']['requestBody']['content']['application/json'];
+export type CreateDamOptions = operations['DAMs_Create']['requestBody']['content']['application/json'];
+export declare class OrgClient {
+    #private;
+    constructor(uuid: string, client: CloudCannonClient);
+    sites(): Promise<Site[]>;
+    createSite(name: string, stableDomain?: string): Promise<Site>;
+    connectSite(name: string, providerDetails: ConnectSiteOptions, stableDomain?: string): Promise<Site>;
+    get(): Promise<Org>;
+    getInboxes(): Promise<Inbox[]>;
+    createInbox(body: CreateInboxOptions): Promise<Inbox>;
+    getDams(): Promise<Dam[]>;
+    createDam(body: CreateDamOptions): Promise<Dam>;
+    getRepositories(provider: Provider): Promise<Repository[]>;
+}

package/dist/src/org.js

@@ -0,0 +1,121 @@
+import { ApiError } from "./errors.js";
+export class OrgClient {
+    #uuid;
+    #client;
+    constructor(uuid, client) {
+        this.#uuid = uuid;
+        this.#client = client;
+    }
+    async sites() {
+        const resp = await this.#client.fetch(`/orgs/${this.#uuid}/sites`);
+        if (resp.status === 401 || resp.status === 403) {
+            throw new Error('Error fetching sites. Permission denied');
+        }
+        const sites = await resp.json();
+        return sites;
+    }
+    async createSite(name, stableDomain) {
+        const resp = await this.#client.fetch(`/orgs/${this.#uuid}/sites`, {
+            method: 'POST',
+            body: { site_name: name, stable_domain: stableDomain },
+        });
+        if (resp.status === 401) {
+            throw new Error('Error creating site. Permission denied');
+        }
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error creating site. Invalid request', errorResp.errors, `/orgs/${this.#uuid}/sites`, { name, stableDomain }, 422);
+        }
+        const siteResp = await resp.json();
+        if (!siteResp) {
+            throw new Error('Invalid response');
+        }
+        return siteResp;
+    }
+    async connectSite(name, providerDetails, stableDomain) {
+        const body = {
+            site_name: name,
+            stable_domain: stableDomain,
+            provider: providerDetails.provider,
+            repo: providerDetails.repository,
+            branch: providerDetails.branch,
+            folder: providerDetails.folder,
+        };
+        const resp = await this.#client.fetch(`/orgs/${this.#uuid}/sites/connect`, {
+            method: 'POST',
+            body,
+        });
+        if (resp.status === 401 || resp.status === 403) {
+            throw new Error('Error creating site. Permission denied');
+        }
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error creating site. Invalid request', errorResp.errors, `/orgs/${this.#uuid}/sites/connect`, body, 422);
+        }
+        const siteResp = await resp.json();
+        return siteResp;
+    }
+    async get() {
+        const resp = await this.#client.fetch(`/orgs/${this.#uuid}`);
+        if (resp.status === 403) {
+            throw new Error('Error fetching org. Permission denied');
+        }
+        const org = await resp.json();
+        return org;
+    }
+    async getInboxes() {
+        const resp = await this.#client.fetch(`/orgs/${this.#uuid}/inboxes`);
+        if (resp.status === 403) {
+            throw new Error('Error fetching inboxes. Permission denied');
+        }
+        const inboxes = await resp.json();
+        return inboxes;
+    }
+    async createInbox(body) {
+        const resp = await this.#client.fetch(`/orgs/${this.#uuid}/inboxes`, {
+            method: 'POST',
+            body,
+        });
+        if (resp.status === 401 || resp.status === 403) {
+            throw new Error('Error creating inbox. Permission denied');
+        }
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error creating inbox. Invalid request', errorResp.errors, `/orgs/${this.#uuid}/inboxes`, body, 422);
+        }
+        const inbox = await resp.json();
+        return inbox;
+    }
+    async getDams() {
+        const resp = await this.#client.fetch(`/orgs/${this.#uuid}/dams`);
+        const dams = await resp.json();
+        return dams;
+    }
+    async createDam(body) {
+        const resp = await this.#client.fetch(`/orgs/${this.#uuid}/dams`, {
+            method: 'POST',
+            body,
+        });
+        if (resp.status === 401) {
+            throw new Error('Error creating dam. Permission denied');
+        }
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error creating dam. Invalid request', errorResp.errors, `/orgs/${this.#uuid}/dams`, body, 422);
+        }
+        const dam = await resp.json();
+        return dam;
+    }
+    async getRepositories(provider) {
+        const resp = await this.#client.fetch(`/orgs/${this.#uuid}/providers/${provider}/repositories`);
+        if (resp.status === 401 || resp.status === 403) {
+            throw new Error('Error fetching repositories. Permission denied');
+        }
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error fetching repositories. Invalid request', errorResp.errors, `/orgs/${this.#uuid}/providers/${provider}/repositories`, null, 422);
+        }
+        const repos = await resp.json();
+        return repos;
+    }
+}

package/dist/src/site-inbox.d.ts

@@ -0,0 +1,9 @@
+import type CloudCannonClient from '../index.ts';
+import type { SiteInbox } from '../index.ts';
+import type { operations } from '../schema.js';
+export type UpdateInboxOptions = operations['Site Inboxes_Update']['requestBody']['content']['application/json'];
+export declare class SiteInboxClient {
+    #private;
+    constructor(uuid: string, client: CloudCannonClient);
+    update(body: UpdateInboxOptions): Promise<SiteInbox>;
+}

package/dist/src/site-inbox.js

@@ -0,0 +1,24 @@
+import { ApiError } from "./errors.js";
+export class SiteInboxClient {
+    #uuid;
+    #client;
+    constructor(uuid, client) {
+        this.#uuid = uuid;
+        this.#client = client;
+    }
+    async update(body) {
+        const resp = await this.#client.fetch(`/site-inboxes/${this.#uuid}`, {
+            method: 'PUT',
+            body,
+        });
+        if (resp.status === 401 || resp.status === 403) {
+            throw new Error('Error updating inbox. Permission denied');
+        }
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error updating inbox. Invalid request', errorResp.errors, `/site-inboxes/${this.#uuid}`, { method: 'PUT', body }, resp.status);
+        }
+        const siteInbox = await resp.json();
+        return siteInbox;
+    }
+}

package/dist/src/site.d.ts

@@ -0,0 +1,51 @@
+import type CloudCannonClient from '../index.ts';
+import type { Build, 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?: {
+        install_command?: string;
+        build_command?: string;
+        output_path: string;
+        environment_variables?: [{
+            key: string;
+            value: string;
+        }];
+        hugoVersion?: string;
+        denoVersion?: string;
+        rubyVersion?: string;
+        nodeVersion?: string;
+        preserved_paths?: string[];
+        preserveOutput?: boolean;
+        includeGit?: boolean;
+        manually_configure_urls?: boolean;
+    };
+};
+export type UpdateSiteOptions = operations['Sites_Update']['requestBody']['content']['application/json'];
+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 declare class SiteClient {
+    #private;
+    constructor(uuid: string, client: CloudCannonClient);
+    get(): Promise<Site>;
+    update(body: UpdateSiteOptions): Promise<Site>;
+    delete(): Promise<void>;
+    copy(body: CopySiteOptions): Promise<Site>;
+    updateBuildConfig(options: BuildConfiguration): Promise<Site>;
+    getBuilds(): Promise<Build[]>;
+    rebuild(): Promise<void>;
+    getFile(path: string): Promise<Response>;
+    getSyncs(): Promise<Sync[]>;
+    getScan(): Promise<SiteScan>;
+    getScreenshotHashes(): Promise<Record<string, string>>;
+    getScreenshot(device: 'desktop' | 'mobile', path: string): Promise<Response>;
+    connectSourceProvider(options: ProviderDetails): Promise<Site>;
+    updateSourceProvider(options: Omit<ProviderDetails, 'provider'>): Promise<Site>;
+    disconnectSourceProvider(): Promise<Site>;
+    connectOutputProvider(options: ProviderDetails): Promise<Site>;
+    disconnectOutputProvider(): Promise<Site>;
+    getInboxConnections(): Promise<SiteInbox[]>;
+    connectInbox(body: ConnectInboxOptions): Promise<SiteInbox>;
+    getDamConnections(): Promise<SiteDam[]>;
+    connectDam(body: ConnectDamOptions): Promise<SiteDam>;
+}

package/dist/src/site.js

@@ -0,0 +1,254 @@
+import { ApiError } from "./errors.js";
+export class SiteClient {
+    #uuid;
+    #client;
+    constructor(uuid, client) {
+        this.#uuid = uuid;
+        this.#client = client;
+    }
+    async get() {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}`);
+        const site = await resp.json();
+        return site;
+    }
+    async update(body) {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}`, {
+            method: 'PUT',
+            body,
+        });
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error updating site. Invalid request', errorResp.errors, `/sites/${this.#uuid}`, { method: 'PUT', body }, resp.status);
+        }
+        const site = await resp.json();
+        return site;
+    }
+    async delete() {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}`, {
+            method: 'DELETE',
+        });
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error deleting site. Invalid request', errorResp.errors, `/sites/${this.#uuid}`, { method: 'DELETE' }, resp.status);
+        }
+    }
+    async copy(body) {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/copy`, {
+            method: 'POST',
+            body,
+        });
+        if (resp.status === 402) {
+            throw new Error('Error copying site. Feature not on plan');
+        }
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error copying site. Invalid request', errorResp.errors, `/sites/${this.#uuid}/copy`, { method: 'POST', body }, resp.status);
+        }
+        const site = await resp.json();
+        return site;
+    }
+    async updateBuildConfig(options) {
+        const buildConfiguration = {
+            compile: {
+                ...options.compile,
+                preserved_paths: options.compile?.preserved_paths?.join(','),
+            },
+        };
+        const body = {
+            ...options,
+            uses_i18n: !!options.uses_i18n,
+            build_configuration: JSON.stringify(buildConfiguration),
+        };
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/build`, {
+            method: 'PUT',
+            body,
+        });
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error updating build configuration. Invalid request', errorResp.errors, `/sites/${this.#uuid}/build`, { method: 'PUT', body }, resp.status);
+        }
+        const site = await resp.json();
+        return site;
+    }
+    async getBuilds() {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/builds`);
+        if (resp.status === 401 || resp.status === 403) {
+            throw new Error('Error fetching builds. Permission denied');
+        }
+        const builds = await resp.json();
+        return builds;
+    }
+    async rebuild() {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/builds`, {
+            method: 'POST',
+        });
+        if (resp.status === 401 || resp.status === 403) {
+            throw new Error('Error creating build. Permission denied');
+        }
+    }
+    async getFile(path) {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/files/${encodeURIComponent(path)}`);
+        if (resp.status === 401 || resp.status === 403) {
+            throw new Error('Error fetching file. Permission denied');
+        }
+        if (resp.status === 404) {
+            throw new Error('Error fetching file. File not found');
+        }
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error fetching file. Invalid request', errorResp.errors, `/sites/${this.#uuid}/files/${encodeURIComponent(path)}`, {}, resp.status);
+        }
+        return resp;
+    }
+    async getSyncs() {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/syncs`);
+        if (resp.status === 401) {
+            throw new Error('Error fetching syncs. Permission denied');
+        }
+        const syncs = await resp.json();
+        return syncs;
+    }
+    async getScan() {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/scans`);
+        if (resp.status === 401 || resp.status === 403) {
+            throw new Error('Error fetching scans. Permission denied');
+        }
+        const scan = await resp.json();
+        return scan;
+    }
+    async getScreenshotHashes() {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/screenshots`);
+        if (resp.status === 401 || resp.status === 403) {
+            throw new Error('Error fetching file. Permission denied');
+        }
+        const screenshots = await resp.json();
+        return screenshots;
+    }
+    async getScreenshot(device, path) {
+        return this.#client.fetch(`/sites/${this.#uuid}/screenshots/${device}?path=${encodeURIComponent(path)}`);
+    }
+    async connectSourceProvider(options) {
+        const body = {
+            storage_provider: options.provider,
+            custom_data: {
+                branch: options.branch,
+                full_name: options.repository,
+            },
+        };
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/providers`, {
+            method: 'POST',
+            body,
+        });
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error adding provider. Invalid request', errorResp.errors, `/sites/${this.#uuid}/providers`, { method: 'POST', body }, resp.status);
+        }
+        const site = await resp.json();
+        return site;
+    }
+    async updateSourceProvider(options) {
+        const body = {
+            custom_data: {
+                branch: options.branch,
+                full_name: options.repository,
+            },
+        };
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/providers`, {
+            method: 'PUT',
+            body,
+        });
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error updating provider. Invalid request', errorResp.errors, `/sites/${this.#uuid}/providers`, { method: 'PUT', body }, resp.status);
+        }
+        const site = await resp.json();
+        return site;
+    }
+    async disconnectSourceProvider() {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/providers`, {
+            method: 'DELETE',
+        });
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error removing provider. Invalid request', errorResp.errors, `/sites/${this.#uuid}/providers`, { method: 'DELETE' }, resp.status);
+        }
+        const site = await resp.json();
+        return site;
+    }
+    async connectOutputProvider(options) {
+        const body = {
+            storage_provider: options.provider,
+            custom_data: {
+                branch: options.branch,
+                full_name: options.repository,
+            },
+        };
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/output-providers`, {
+            method: 'POST',
+            body,
+        });
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error adding output provider. Invalid request', errorResp.errors, `/sites/${this.#uuid}/output-providers`, { method: 'POST', body }, resp.status);
+        }
+        const site = await resp.json();
+        return site;
+    }
+    async disconnectOutputProvider() {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/output-providers`, {
+            method: 'DELETE',
+        });
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error removing output provider. Invalid request', errorResp.errors, `/sites/${this.#uuid}/output-providers`, { method: 'DELETE' }, resp.status);
+        }
+        const site = await resp.json();
+        return site;
+    }
+    async getInboxConnections() {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/inboxes`);
+        if (resp.status === 403) {
+            throw new Error('Error fetching inboxes. Permission denied');
+        }
+        const inboxes = await resp.json();
+        return inboxes;
+    }
+    async connectInbox(body) {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/inboxes`, {
+            method: 'POST',
+            body,
+        });
+        if (resp.status === 401 || resp.status === 403) {
+            throw new Error('Error creating inbox. Permission denied');
+        }
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error creating inbox. Invalid request', errorResp.errors, `/sites/${this.#uuid}/inboxes`, { method: 'POST', body }, resp.status);
+        }
+        const inbox = await resp.json();
+        return inbox;
+    }
+    async getDamConnections() {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/dams`);
+        if (resp.status === 403) {
+            throw new Error('Error fetching dams. Permission denied');
+        }
+        const dams = await resp.json();
+        return dams;
+    }
+    async connectDam(body) {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/dams`, {
+            method: 'POST',
+            body,
+        });
+        if (resp.status === 401 || resp.status === 403) {
+            throw new Error('Error creating dam. Permission denied');
+        }
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error creating dam. Invalid request', errorResp.errors, `/sites/${this.#uuid}/dams`, { method: 'POST', body }, resp.status);
+        }
+        const dam = await resp.json();
+        return dam;
+    }
+}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@cloudcannon/sdk",
+  "type": "module",
+  "version": "0.0.0",
+  "description": "REST API client for the CloudCannon CMS.",
+  "keywords": [
+    "cloudcannon",
+    "cms",
+    "sdk",
+    "static site generator",
+    "configuration"
+  ],
+  "homepage": "https://github.com/CloudCannon/sdk#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/CloudCannon/sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/CloudCannon/sdk/issues",
+    "email": "support@cloudcannon.com"
+  },
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "main": "dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "devEngines": {
+    "packageManager": {
+      "name": "npm"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "node --test",
+    "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"
+  },
+  "author": "CloudCannon <support@cloudcannon.com>",
+  "license": "ISC",
+  "devDependencies": {
+    "@biomejs/biome": "2.4.13",
+    "@types/node": "25.6.0",
+    "typescript": "6.0.3"
+  },
+  "dependencies": {
+  }
+}