@cloudcannon/sdk 0.0.3 → 0.0.5

package/dist/index.d.ts

@@ -1,15 +1,15 @@
 import type { components, operations, paths } from './schema.ts';
 import { BackupClient } from './src/backup.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 { type CommitEditingSessionOptions, type CommitEditingSessionResponse, type CreateEditingSessionFileOptions, EditingSessionClient } from './src/editing-session.ts';
+import { type CreateContributionOptions, EditingSessionFileClient, type UnlockOptions } from './src/editing-session-file.ts';
 import { type FilterOptions, type PaginatedResponse, type PaginationOptions, type SortingOptions } from './src/helpers/query.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';
+import { InboxClient, type ListInboxSubmissionsOptions } from './src/inbox.ts';
+import { type ConnectSiteOptions, type CreateDamOptions, type CreateInboxOptions, type ListOrgDamsOptions, type ListOrgInboxesOptions, type ListOrgSitesOptions, OrgClient } from './src/org.ts';
+import { type BuildConfiguration, type ConnectDamOptions, type ConnectInboxOptions, type CopySiteOptions, type CreateBackupOptions, type ListSiteBackupsOptions, type ListSiteBuildsOptions, type ListSiteSyncsOptions, SiteClient, type UpdateSiteOptions, type UploadFileOptions } from './src/site.ts';
+import { SiteInboxClient, type UpdateInboxOptions } from './src/site-inbox.ts';
 import { SyncClient } from './src/sync.ts';
-export type { BuildConfiguration, CommitEditingSessionOptions, CommitEditingSessionResponse, FilterOptions, PaginatedResponse, PaginationOptions, SortingOptions, };
+export type { BuildConfiguration, CommitEditingSessionOptions, CommitEditingSessionResponse, ConnectDamOptions, ConnectInboxOptions, ConnectSiteOptions, CopySiteOptions, CreateBackupOptions, CreateContributionOptions, CreateDamOptions, CreateEditingSessionFileOptions, CreateInboxOptions, FilterOptions, ListInboxSubmissionsOptions, ListOrgDamsOptions, ListOrgInboxesOptions, ListOrgSitesOptions, ListOrgsOptions, ListSiteBackupsOptions, ListSiteBuildsOptions, ListSiteSyncsOptions, PaginatedResponse, PaginationOptions, SortingOptions, UnlockOptions, UpdateInboxOptions, UpdateSiteOptions, UploadFileOptions, };
 export type Provider = operations['Providers_Repositories']['parameters']['path']['provider'];
 export type Site = components['schemas']['SiteBlueprint'];
 export type Backup = components['schemas']['SiteArchiveBlueprint'];
@@ -31,6 +31,7 @@ export type ProviderDetails = {
     repository: string;
     branch: string;
 };
+type ListOrgsOptions = PaginationOptions & SortingOptions<operations['Organizations_Index']> & FilterOptions<operations['Organizations_Index']>;
 type ParamToString<S extends string> = S extends `${infer A}/{${string}}/${infer B}` ? `${A}/${string}/${ParamToString<B>}` : S extends `${infer A}/{${string}}` ? `${A}/${string}` : S;
 type StripPrefix<S extends string> = S extends `/api/v0${infer Rest}` ? Rest : never;
 type StripParams<S extends string> = S extends `${infer Path}?${string}` ? Path : S;
@@ -71,15 +72,24 @@ type MatchURL<M extends keyof paths[keyof paths], U extends string> = {
 type ValidURL<M extends keyof paths[keyof paths], U extends string> = MatchURL<M, U> extends never ? {
     [K in keyof paths]: RequestParams<paths[K][M]> extends never ? never : StripPrefix<K>;
 }[keyof paths] : U;
-export type CloudCannonClientConfig = {
-    key: string;
+type BaseCloudCannonClientConfig = {
     apiOrigin?: string;
     getCustomAuthHeaders?: () => Record<string, string>;
 };
+export type CloudCannonClientConfig = ({
+    key: string;
+} & BaseCloudCannonClientConfig) | ({
+    userAccessKey: UserAccessKey;
+} & BaseCloudCannonClientConfig);
+export type UserAccessKey = {
+    id: string;
+    secret: string;
+};
 export default class CloudCannonClient {
     #private;
     constructor(config: CloudCannonClientConfig);
-    getAuthHeaders(): Record<string, string>;
+    getAuthHeaders(url: string, body?: string): Promise<Record<string, string>>;
+    signRequest(userAccessKey: UserAccessKey, url: string, body?: string | null): Promise<Record<string, string>>;
     fetch<const U extends string, const M extends Uppercase<keyof paths[keyof paths]> = 'GET'>(url: ValidURL<Lowercase<M>, U>, options?: Omit<RequestInit, keyof RequestMixin<M, MatchURL<Lowercase<M>, U>[Lowercase<M>]>> & RequestMixin<M, MatchURL<Lowercase<M>, U>[Lowercase<M>]>): Promise<APIResponse<MatchURL<Lowercase<M>, U>[Lowercase<M>]>>;
     org(uuid: string): OrgClient;
     site(uuid: string): SiteClient;
@@ -90,6 +100,6 @@ export default class CloudCannonClient {
     build(uuid: string): BuildClient;
     backup(uuid: string): BackupClient;
     sync(uuid: string): SyncClient;
-    orgs(options?: PaginationOptions & SortingOptions<operations['Organizations_Index']> & FilterOptions<operations['Organizations_Index']>): Promise<PaginatedResponse<Org>>;
+    orgs(options?: ListOrgsOptions): Promise<PaginatedResponse<Org>>;
     getUploadData(): Promise<UploadData>;
 }

package/dist/index.js

@@ -1,50 +1,75 @@
+import { createHmac, randomUUID } from 'node:crypto';
 import { BackupClient } from "./src/backup.js";
 import { BuildClient } from "./src/build.js";
 import { EditingSessionClient, } from "./src/editing-session.js";
-import { EditingSessionFileClient } from "./src/editing-session-file.js";
+import { EditingSessionFileClient, } from "./src/editing-session-file.js";
 import { buildQuery, paginatedResponse, } from "./src/helpers/query.js";
 import { InboxClient } from "./src/inbox.js";
-import { OrgClient } from "./src/org.js";
-import { SiteClient } from "./src/site.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;
+    #userAccessKey;
     #appDomain;
     #getCustomAuthHeaders;
     constructor(config) {
-        this.#apiKey = config.key;
+        if ('userAccessKey' in config) {
+            this.#userAccessKey = config.userAccessKey;
+        }
+        else {
+            this.#apiKey = config.key;
+        }
         this.#appDomain = config.apiOrigin ?? 'app.cloudcannon.com';
         this.#getCustomAuthHeaders = config.getCustomAuthHeaders;
     }
-    getAuthHeaders() {
+    async getAuthHeaders(url, body) {
         if (this.#getCustomAuthHeaders) {
-            return {
-                ...this.#getCustomAuthHeaders(),
-            };
+            return this.#getCustomAuthHeaders();
+        }
+        if (this.#userAccessKey) {
+            return this.signRequest(this.#userAccessKey, url, body);
         }
         return {
             'X-API-KEY': `${this.#apiKey}`,
         };
     }
+    async signRequest(userAccessKey, url, body) {
+        const signedAtISO = new Date().toISOString();
+        const nonce = randomUUID();
+        const key = Buffer.from(userAccessKey.secret, 'base64');
+        const message = JSON.stringify({ url, signed_at: signedAtISO, body: body ?? '', nonce });
+        const digest = createHmac('sha256', key).update(message).digest('hex');
+        return {
+            'X-CC-ACCESS-KEY': userAccessKey.id,
+            'X-CC-SIGNED-AT': signedAtISO,
+            'X-CC-CHECKSUM': digest,
+            'X-CC-NONCE': nonce,
+        };
+    }
     async fetch(url, options) {
+        const fullUrl = `https://${this.#appDomain}/api/v0${url}`;
+        let body;
+        if (options?.body) {
+            if (typeof options?.body !== 'string') {
+                body = JSON.stringify(options.body);
+            }
+            else {
+                body = options.body;
+            }
+        }
+        const authHeaders = await this.getAuthHeaders(fullUrl, body);
         const requestInit = {
             ...options,
             headers: {
-                ...this.getAuthHeaders(),
+                ...authHeaders,
                 'Content-Type': 'application/json',
                 ...options?.headers,
             },
+            body,
         };
-        if (options?.body) {
-            if (typeof options?.body !== 'string') {
-                requestInit.body = JSON.stringify(options.body);
-            }
-            else {
-                requestInit.body = options.body;
-            }
-        }
-        return fetch(`https://${this.#appDomain}/api/v0${url}`, requestInit);
+        return fetch(fullUrl, requestInit);
     }
     org(uuid) {
         return new OrgClient(uuid, this);
@@ -75,7 +100,7 @@ export default class CloudCannonClient {
     }
     async orgs(options = {}) {
         const query = buildQuery(options);
-        const resp = await this.fetch(`/orgs?${query}`);
+        const resp = await this.fetch(`/orgs${query}`);
         if (resp.status === 403) {
             throw new Error('Error fetching orgs. Permission denied');
         }

package/dist/src/helpers/query.d.ts

@@ -24,5 +24,5 @@ export declare function buildQuery(options?: PaginationOptions & {
     sort_attribute?: string;
     sort_direction?: 'ASC' | 'DESC';
     filters?: Record<string, unknown>;
-}): string;
+}): `?${string}` | '';
 export declare function paginatedResponse<T>(items: T[], headers: Headers): PaginatedResponse<T>;

package/dist/src/helpers/query.js

@@ -3,7 +3,7 @@ export function buildQuery(options = {}) {
     if (options.page !== undefined)
         params.set('page', String(options.page));
     if (options.items !== undefined)
-        params.set('item', String(options.items));
+        params.set('items', String(options.items));
     if (options.sort_attribute !== undefined)
         params.set('sort_attribute', options.sort_attribute);
     if (options.sort_direction !== undefined)
@@ -15,7 +15,11 @@ export function buildQuery(options = {}) {
             }
         }
     }
-    return params.toString();
+    const result = params.toString();
+    if (result.length > 0) {
+        return `?${result}`;
+    }
+    return '';
 }
 export function paginatedResponse(items, headers) {
     const parse = (name) => {

package/dist/src/inbox.d.ts

@@ -2,8 +2,9 @@ import type CloudCannonClient from '../index.ts';
 import type { FormSubmission } from '../index.ts';
 import type { operations } from '../schema.js';
 import { type FilterOptions, type PaginatedResponse, type PaginationOptions, type SortingOptions } from './helpers/query.ts';
+export type ListInboxSubmissionsOptions = PaginationOptions & SortingOptions<operations['Inbox Form Hooks_Index']> & FilterOptions<operations['Inbox Form Hooks_Index']>;
 export declare class InboxClient {
     #private;
     constructor(uuid: string, client: CloudCannonClient);
-    getSubmissions(options?: PaginationOptions & SortingOptions<operations['Inbox Form Hooks_Index']> & FilterOptions<operations['Inbox Form Hooks_Index']>): Promise<PaginatedResponse<FormSubmission>>;
+    getSubmissions(options?: ListInboxSubmissionsOptions): Promise<PaginatedResponse<FormSubmission>>;
 }

package/dist/src/inbox.js

@@ -8,7 +8,7 @@ export class InboxClient {
     }
     async getSubmissions(options = {}) {
         const query = buildQuery(options);
-        const resp = await this.#client.fetch(`/inboxes/${this.#uuid}/form-hooks?${query}`);
+        const resp = await this.#client.fetch(`/inboxes/${this.#uuid}/form-hooks${query}`);
         if (resp.status === 401 || resp.status === 403) {
             throw new Error('Error fetching submissions. Permission denied');
         }

package/dist/src/org.d.ts

@@ -6,18 +6,21 @@ export interface ConnectSiteOptions extends ProviderDetails {
     folder?: string;
 }
 export type Repository = operations['Providers_Repositories']['responses']['200']['content']['application/json'][number];
+export type ListOrgSitesOptions = PaginationOptions & SortingOptions<operations['Sites_Index']> & FilterOptions<operations['Sites_Index']>;
+export type ListOrgInboxesOptions = PaginationOptions & SortingOptions<operations['Organization Inboxes_Index']> & FilterOptions<operations['Organization Inboxes_Index']>;
+export type ListOrgDamsOptions = PaginationOptions & SortingOptions<operations['DAMs_Index']> & FilterOptions<operations['DAMs_Index']>;
 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(options?: PaginationOptions & SortingOptions<operations['Sites_Index']> & FilterOptions<operations['Sites_Index']>): Promise<PaginatedResponse<Site>>;
+    sites(options?: ListOrgSitesOptions): Promise<PaginatedResponse<Site>>;
     createSite(name: string, stableDomain?: string): Promise<Site>;
     connectSite(name: string, providerDetails: ConnectSiteOptions, stableDomain?: string): Promise<Site>;
     get(): Promise<Org>;
-    getInboxes(options?: PaginationOptions & SortingOptions<operations['Organization Inboxes_Index']> & FilterOptions<operations['Organization Inboxes_Index']>): Promise<PaginatedResponse<Inbox>>;
+    getInboxes(options?: ListOrgInboxesOptions): Promise<PaginatedResponse<Inbox>>;
     createInbox(body: CreateInboxOptions): Promise<Inbox>;
-    getDams(options?: PaginationOptions & SortingOptions<operations['DAMs_Index']> & FilterOptions<operations['DAMs_Index']>): Promise<PaginatedResponse<Dam>>;
+    getDams(options?: ListOrgDamsOptions): Promise<PaginatedResponse<Dam>>;
     createDam(body: CreateDamOptions): Promise<Dam>;
     getRepositories(provider: Provider): Promise<Repository[]>;
 }

package/dist/src/org.js

@@ -9,7 +9,7 @@ export class OrgClient {
     }
     async sites(options = {}) {
         const query = buildQuery(options);
-        const resp = await this.#client.fetch(`/orgs/${this.#uuid}/sites?${query}`);
+        const resp = await this.#client.fetch(`/orgs/${this.#uuid}/sites${query}`);
         if (resp.status === 401 || resp.status === 403) {
             throw new Error('Error fetching sites. Permission denied');
         }
@@ -67,7 +67,7 @@ export class OrgClient {
     }
     async getInboxes(options = {}) {
         const query = buildQuery(options);
-        const resp = await this.#client.fetch(`/orgs/${this.#uuid}/inboxes?${query}`);
+        const resp = await this.#client.fetch(`/orgs/${this.#uuid}/inboxes${query}`);
         if (resp.status === 403) {
             throw new Error('Error fetching inboxes. Permission denied');
         }
@@ -91,7 +91,7 @@ export class OrgClient {
     }
     async getDams(options = {}) {
         const query = buildQuery(options);
-        const resp = await this.#client.fetch(`/orgs/${this.#uuid}/dams?${query}`);
+        const resp = await this.#client.fetch(`/orgs/${this.#uuid}/dams${query}`);
         const dams = await resp.json();
         return paginatedResponse(dams, resp.headers);
     }

package/dist/src/site.d.ts

@@ -23,6 +23,9 @@ export type BuildConfiguration = Partial<Omit<operations['Sites_UpdateBuild']['r
 };
 export type UpdateSiteOptions = operations['Sites_Update']['requestBody']['content']['application/json'];
 export type CopySiteOptions = operations['Sites_Copy']['requestBody']['content']['application/json'];
+export type ListSiteBuildsOptions = PaginationOptions & SortingOptions<operations['Builds_Index']> & FilterOptions<operations['Builds_Index']>;
+export type ListSiteBackupsOptions = PaginationOptions & SortingOptions<operations['Backups_Index']> & FilterOptions<operations['Backups_Index']>;
+export type ListSiteSyncsOptions = PaginationOptions & SortingOptions<operations['Syncs_Index']> & FilterOptions<operations['Syncs_Index']>;
 export type CreateBackupOptions = operations['Backups_Create']['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'];
@@ -39,15 +42,15 @@ export declare class SiteClient {
     delete(): Promise<void>;
     copy(body: CopySiteOptions): Promise<Site>;
     updateBuildConfig(options: BuildConfiguration): Promise<Site>;
-    getBuilds(options?: PaginationOptions & SortingOptions<operations['Builds_Index']> & FilterOptions<operations['Builds_Index']>): Promise<PaginatedResponse<Build>>;
+    getBuilds(options?: ListSiteBuildsOptions): Promise<PaginatedResponse<Build>>;
     rebuild(): Promise<void>;
-    listBackups(options?: PaginationOptions & SortingOptions<operations['Backups_Index']> & FilterOptions<operations['Backups_Index']>): Promise<PaginatedResponse<Backup>>;
+    listBackups(options?: ListSiteBackupsOptions): Promise<PaginatedResponse<Backup>>;
     createBackup(body?: CreateBackupOptions): Promise<{
         socket_message_id?: string;
     }>;
     listFiles(): Promise<FileListing[]>;
     getFile(path: string): Promise<Response>;
-    getSyncs(options?: PaginationOptions & SortingOptions<operations['Syncs_Index']> & FilterOptions<operations['Syncs_Index']>): Promise<PaginatedResponse<Sync>>;
+    getSyncs(options?: ListSiteSyncsOptions): Promise<PaginatedResponse<Sync>>;
     getScan(): Promise<SiteScan>;
     getScreenshotHashes(): Promise<Record<string, string>>;
     getScreenshot(device: 'desktop' | 'mobile', path: string): Promise<Response>;
@@ -64,4 +67,5 @@ export declare class SiteClient {
     createEditingSession(): Promise<EditingSession>;
     getLatestEditingSession(): Promise<EditingSession>;
     uploadFile(path: string, content: BlobPart, options?: UploadFileOptions): Promise<void>;
+    triggerPull(): Promise<void>;
 }

package/dist/src/site.js

@@ -73,7 +73,7 @@ export class SiteClient {
     }
     async getBuilds(options = {}) {
         const query = buildQuery(options);
-        const resp = await this.#client.fetch(`/sites/${this.#uuid}/builds?${query}`);
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/builds${query}`);
         if (resp.status === 401 || resp.status === 403) {
             throw new Error('Error fetching builds. Permission denied');
         }
@@ -90,7 +90,7 @@ export class SiteClient {
     }
     async listBackups(options = {}) {
         const query = buildQuery(options);
-        const resp = await this.#client.fetch(`/sites/${this.#uuid}/archives?${query}`);
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/archives${query}`);
         if (resp.status === 401) {
             throw new Error('Error fetching backups. Permission denied');
         }
@@ -140,7 +140,7 @@ export class SiteClient {
     }
     async getSyncs(options = {}) {
         const query = buildQuery(options);
-        const resp = await this.#client.fetch(`/sites/${this.#uuid}/syncs?${query}`);
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/syncs${query}`);
         if (resp.status === 401) {
             throw new Error('Error fetching syncs. Permission denied');
         }
@@ -369,4 +369,13 @@ export class SiteClient {
             previous_content_hash: contentHash,
         });
     }
+    async triggerPull() {
+        const resp = await this.#client.fetch(`/sites/${this.#uuid}/providers/sync`, {
+            method: 'POST',
+        });
+        if (resp.status === 422) {
+            const errorResp = await resp.json();
+            throw new ApiError('Error triggering pull on site. Invalid request', errorResp.errors, `/sites/${this.#uuid}/providers/sync`, { method: 'POST' }, resp.status);
+        }
+    }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloudcannon/sdk",
   "type": "module",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "REST API client for the CloudCannon CMS.",
   "keywords": [
     "cloudcannon",