webflow-api 1.2.1 → 1.3.0

package/tests/fixtures/site.fixture.ts

@@ -0,0 +1,78 @@
+export const SiteFixture = {
+  list: {
+    response: [
+      {
+        _id: "580e63e98c9a982ac9b8b741",
+        createdOn: "2016-10-24T19:41:29.156Z",
+        name: "api_docs_sample_json",
+        shortName: "api-docs-sample-json",
+        lastPublished: "2016-10-24T23:06:51.251Z",
+        previewUrl:
+          "https://d1otoma47x30pg.cloudfront.net/580e63e98c9a982ac9b8b741/201610241603.png",
+        timezone: "America/Los_Angeles",
+        database: "580e63fc8c9a982ac9b8b744",
+      },
+      {
+        _id: "580ff8c3ba3e45ba9fe588bb",
+        createdOn: "2016-10-26T00:28:54.191Z",
+        name: "Copy of api_docs_sample_json",
+        shortName: "api-docs-sample-json-086c6538f9b0583762",
+        lastPublished: null,
+        previewUrl:
+          "https://d1otoma47x30pg.cloudfront.net/580e63e98c9a982ac9b8b741/201610241603.png",
+        timezone: "America/Los_Angeles",
+        database: "580ff8c3ba3e45ba9fe588bf",
+      },
+      {
+        _id: "580ff8d7ba3e45ba9fe588e9",
+        createdOn: "2016-10-26T00:29:13.634Z",
+        name: "Copy of api_docs_sample_json",
+        shortName: "api-docs-sample-json-ce077aa6c5cd3e0177",
+        lastPublished: null,
+        previewUrl:
+          "https://d1otoma47x30pg.cloudfront.net/580e63e98c9a982ac9b8b741/201610241603.png",
+        timezone: "America/Los_Angeles",
+        database: "580ff8d7ba3e45ba9fe588ed",
+      },
+    ],
+  },
+  getOne: {
+    parameters: {
+      siteId: "580e63e98c9a982ac9b8b741",
+    },
+    response: {
+      _id: "580e63e98c9a982ac9b8b741",
+      createdOn: "2016-10-24T19:41:29.156Z",
+      name: "api_docs_sample_json",
+      shortName: "api-docs-sample-json",
+      lastPublished: "2016-10-24T19:43:17.271Z",
+      previewUrl: "https://d1otoma47x30pg.cloudfront.net/580e63e98c9a982ac9b8b741/201610241243.png",
+      timezone: "America/Los_Angeles",
+      database: "580e63fc8c9a982ac9b8b744",
+    },
+  },
+  domains: {
+    parameters: {
+      siteId: "580e63e98c9a982ac9b8b741",
+    },
+    response: [
+      {
+        _id: "589a331aa51e760df7ccb89d",
+        name: "test-api-domain.com",
+      },
+      {
+        _id: "589a331aa51e760df7ccb89e",
+        name: "www.test-api-domain.com",
+      },
+    ],
+  },
+  publish: {
+    parameters: {
+      siteId: "580e63e98c9a982ac9b8b741",
+      domains: ["test-api-domain.com"],
+    },
+    response: {
+      queued: true,
+    },
+  },
+};

package/tests/fixtures/user.fixture.ts

@@ -0,0 +1,175 @@
+export const UserFixture = {
+  getOne: {
+    parameters: {
+      userId: "6287ec36a841b25637c663df",
+      siteId: "580e63e98c9a982ac9b8b741",
+    },
+    response: {
+      _id: "6287ec36a841b25637c663df",
+      createdOn: "2022-05-20T13:46:12.093Z",
+      updatedOn: "2022-05-20T13:46:12.093Z",
+      emailVerified: true,
+      status: "verified",
+      data: {
+        "accept-privacy": false,
+        "accept-communications": false,
+        email: "Some.One@home.com",
+        name: "Some One",
+      },
+    },
+  },
+  list: {
+    parameters: {
+      siteId: "580e63e98c9a982ac9b8b741",
+    },
+    response: {
+      users: [
+        {
+          _id: "6287ec36a841b25637c663df",
+          createdOn: "2022-05-20T13:46:12.093Z",
+          updatedOn: "2022-05-20T13:46:12.093Z",
+          emailVerified: false,
+          status: "unverified",
+          data: {
+            "accept-privacy": false,
+            "accept-communications": false,
+            email: "Person.One@home.com",
+            name: "Person One",
+          },
+        },
+        {
+          _id: "6287ec36a841b25637c663f0",
+          createdOn: "2022-05-19T05:32:04.581Z",
+          updatedOn: "2022-05-19T05:32:04.581Z",
+          emailVerified: false,
+          status: "unverified",
+          data: {
+            "accept-privacy": false,
+            "accept-communications": false,
+            email: "Person.Two@home.com",
+            name: "Person Two",
+          },
+        },
+        {
+          _id: "6287ec36a841b25637c663d9",
+          createdOn: "2022-05-17T03:34:06.720Z",
+          updatedOn: "2022-05-17T03:34:06.720Z",
+          emailVerified: true,
+          status: "verified",
+          data: {
+            "accept-privacy": false,
+            "accept-communications": false,
+            email: "Person.Three@home.com",
+            name: "Person Three",
+          },
+        },
+        {
+          _id: "6287ec37a841b25637c6641b",
+          createdOn: "2022-05-15T03:46:09.748Z",
+          updatedOn: "2022-05-15T03:46:09.748Z",
+          emailVerified: false,
+          status: "unverified",
+          data: {
+            "accept-privacy": false,
+            "accept-communications": false,
+            email: "Person.Four@home.com",
+            name: "Person Four",
+          },
+        },
+        {
+          _id: "6287ec37a841b25637c66449",
+          createdOn: "2022-05-15T02:55:38.786Z",
+          updatedOn: "2022-05-15T02:55:38.786Z",
+          emailVerified: true,
+          status: "verified",
+          data: {
+            "accept-privacy": false,
+            "accept-communications": false,
+            email: "Person.Five@home.com",
+            name: "Person Five",
+          },
+        },
+      ],
+      count: 5,
+      limit: 5,
+      offset: 0,
+      total: 201,
+    },
+  },
+  invite: {
+    parameters: {
+      siteId: "580e63e98c9a982ac9b8b741",
+      email: "some.one@home.com",
+    },
+    response: {
+      _id: "6287ec36a841b25637c663df",
+      createdOn: "2022-05-20T13:46:12.093Z",
+      updatedOn: "2022-05-20T13:46:12.093Z",
+      emailVerified: true,
+      status: "verified",
+      data: {
+        "accept-privacy": false,
+        "accept-communications": false,
+        email: "some.one@home.com",
+        name: "Some One",
+      },
+    },
+  },
+  update: {
+    parameters: {
+      userId: "6287ec36a841b25637c663df",
+      siteId: "580e63e98c9a982ac9b8b741",
+      data: {
+        status: "verified",
+        data: {
+          "accept-privacy": false,
+          "accept-communications": false,
+          email: "Some.One@home.com",
+          name: "Some One",
+        },
+      },
+    },
+    response: {
+      _id: "6287ec36a841b25637c663df",
+      createdOn: "2022-05-20T13:46:12.093Z",
+      updatedOn: "2022-05-20T13:46:12.093Z",
+      emailVerified: true,
+      status: "verified",
+      data: {
+        "accept-privacy": false,
+        "accept-communications": false,
+        email: "Some.One@home.com",
+        name: "Some One",
+      },
+    },
+  },
+  delete: {
+    parameters: {
+      userId: "6287ec36a841b25637c663df",
+      siteId: "580e63e98c9a982ac9b8b741",
+    },
+    response: {
+      deleted: 1,
+    },
+  },
+  accessGroups: {
+    parameters: {
+      siteId: "580e63e98c9a982ac9b8b741",
+    },
+    response: {
+      accessGroups: [
+        {
+          _id: "62be58d404be8a6cc900c081",
+          name: "Webflowers",
+          shortId: "jo",
+          slug: "webflowers",
+          createdOn: "2022-08-01T19:41:48.349Z",
+        },
+      ],
+      count: 1,
+      limit: 10,
+      offset: 0,
+      total: 1,
+    },
+  },
+};

package/tests/fixtures/webhook.fixture.ts

@@ -0,0 +1,69 @@
+export const WebhookFixture = {
+  getOne: {
+    parameters: {
+      siteId: "580e63e98c9a982ac9b8b741",
+      webhookId: "582266e0cd48de0f0e3c6d8b",
+    },
+    response: {
+      _id: "582266e0cd48de0f0e3c6d8b",
+      triggerType: "form_submission",
+      triggerId: "580e63e98c9a982ac9b8b741",
+      site: "580e63e98c9a982ac9b8b741",
+      createdOn: "2016-11-08T23:59:28.572Z",
+    },
+  },
+  list: {
+    parameters: {
+      siteId: "580e63e98c9a982ac9b8b741",
+    },
+    response: [
+      {
+        _id: "57ca0a9e418c504a6e1acbb6",
+        triggerType: "form_submission",
+        triggerId: "580e63e98c9a982ac9b8b741",
+        site: "580e63e98c9a982ac9b8b741",
+        lastUsed: "2016-09-06T21:12:22.148Z",
+        createdOn: "2016-09-02T23:26:22.241Z",
+      },
+      {
+        _id: "578d85cce0c47cd2865f4cf2",
+        triggerType: "form_submission",
+        triggerId: "580e63e98c9a982ac9b8b741",
+        site: "580e63e98c9a982ac9b8b741",
+        lastUsed: "2016-09-06T21:12:22.142Z",
+        createdOn: "2016-07-19T01:43:40.585Z",
+      },
+      {
+        _id: "578d85cce0c47cd2865f4cf3",
+        triggerType: "form_submission",
+        triggerId: "580e63e98c9a982ac9b8b741",
+        site: "580e63e98c9a982ac9b8b741",
+        lastUsed: "2016-09-06T21:12:22.192Z",
+        createdOn: "2016-07-19T01:43:40.605Z",
+      },
+    ],
+  },
+  create: {
+    parameters: {
+      siteId: "580e63e98c9a982ac9b8b741",
+      triggerType: "form_submission",
+      url: "https://example.com",
+    },
+    response: {
+      _id: "582266e0cd48de0f0e3c6d8b",
+      triggerType: "form_submission",
+      triggerId: "580e63e98c9a982ac9b8b741",
+      site: "580e63e98c9a982ac9b8b741",
+      createdOn: "2016-11-08T23:59:28.572Z",
+    },
+  },
+  delete: {
+    parameters: {
+      siteId: "580e63e98c9a982ac9b8b741",
+      webhookId: "582266e0cd48de0f0e3c6d8b",
+    },
+    response: {
+      deleted: 1,
+    },
+  },
+};

package/tsconfig.eslint.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "types": ["jest"]
+  },
+  "include": ["src", "tests"]
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "lib": ["es6", "dom"],
+    "module": "CommonJS",
+    "target": "es2020",
+    "outDir": "dist",
+    "moduleResolution": "Node",
+    "esModuleInterop": true,
+    "declaration": true,
+    "baseUrl": "src",
+    "experimentalDecorators": true
+  },
+  "include": ["src"]
+}

package/dist/api/collection.d.ts

@@ -1,112 +0,0 @@
-import { AxiosInstance } from "axios";
-import { WebflowRecord } from "../core";
-import { Item } from ".";
-/**************************************************************
- * Types
- **************************************************************/
-export declare type CollectionFieldType = "Bool" | "Color" | "Date" | "ExtFileRef" | "Set" | "ImageRef" | "Set" | "ItemRef" | "ItemRefSet" | "Link" | "Number" | "Option" | "PlainText" | "RichText" | "Video" | "User" | string;
-export declare type CollectionField = {
-    id: string;
-    type: CollectionFieldType;
-    slug: string;
-    name: string;
-    required: boolean;
-    editable: boolean;
-    validations?: Record<string, string | number | boolean | object>;
-};
-/**************************************************************
- * Interfaces
- **************************************************************/
-export interface ICollection {
-    _id: string;
-    lastUpdated: string;
-    createdOn: string;
-    name: string;
-    slug: string;
-    singularName: string;
-    fields: CollectionField[];
-}
-/**************************************************************
- * Class
- **************************************************************/
-export declare class Collection extends WebflowRecord<ICollection> implements ICollection {
-    fields: CollectionField[];
-    singularName: string;
-    lastUpdated: string;
-    createdOn: string;
-    _id: string;
-    name: string;
-    slug: string;
-    /**************************************************************
-     * Static Methods
-     **************************************************************/
-    /**
-     * Get a list of Collections
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param client The Axios client instance
-     * @returns A list of Collections
-     */
-    static list({ siteId }: {
-        siteId: string;
-    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<ICollection[], any>>;
-    /**
-     * Get a single Collection
-     * @param params The params for the request
-     * @param params.collectionId The collection ID
-     * @param client The Axios client instance
-     * @returns A single Collection
-     */
-    static getOne({ collectionId }: {
-        collectionId: string;
-    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<ICollection, any>>;
-    /**************************************************************
-     * Instance Methods
-     **************************************************************/
-    /**
-     * Get a single Item
-     * @param params The params for the request
-     * @param params.itemId The Item ID
-     * @returns A single Item
-     */
-    item({ itemId }: {
-        itemId: string;
-    }): Promise<Item>;
-    /**
-     * Get a list of Items
-     * @param params The params for the request
-     * @param params.limit The number of items to return (optional)
-     * @param params.offset The number of items to skip (optional)
-     * @returns A list of Items
-     */
-    items({ limit, offset }?: {
-        limit?: number;
-        offset?: number;
-    }): Promise<Item[]>;
-    /**
-     * Remove a single Item
-     * @param params The params for the request
-     * @param params.itemId The Item ID
-     * @returns The result from the removal
-     */
-    removeItem({ itemId }: {
-        itemId: string;
-    }): Promise<import("./item").IItemDelete>;
-    /**
-     * Create a new Item
-     * @param fields The Item fields to create
-     * @returns The created Item
-     */
-    createItem(fields: object): Promise<Item>;
-    /**
-     * Update a single Item
-     * @param params The params for the request
-     * @param params.itemId The Item ID
-     * @param params.fields The fields to update
-     * @returns The updated Item
-     */
-    updateItem({ itemId, fields }: {
-        itemId: string;
-        fields: object;
-    }): Promise<Item>;
-}

package/dist/api/collection.js

@@ -1,94 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Collection = void 0;
-const core_1 = require("../core");
-const _1 = require(".");
-/**************************************************************
- * Class
- **************************************************************/
-class Collection extends core_1.WebflowRecord {
-    /**************************************************************
-     * Static Methods
-     **************************************************************/
-    /**
-     * Get a list of Collections
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param client The Axios client instance
-     * @returns A list of Collections
-     */
-    static list({ siteId }, client) {
-        (0, core_1.requireArgs)({ siteId });
-        const path = `/sites/${siteId}/collections`;
-        return client.get(path);
-    }
-    /**
-     * Get a single Collection
-     * @param params The params for the request
-     * @param params.collectionId The collection ID
-     * @param client The Axios client instance
-     * @returns A single Collection
-     */
-    static getOne({ collectionId }, client) {
-        (0, core_1.requireArgs)({ collectionId });
-        const path = `/collections/${collectionId}`;
-        return client.get(path);
-    }
-    /**************************************************************
-     * Instance Methods
-     **************************************************************/
-    /**
-     * Get a single Item
-     * @param params The params for the request
-     * @param params.itemId The Item ID
-     * @returns A single Item
-     */
-    async item({ itemId }) {
-        const res = await _1.Item.getOne({ itemId, collectionId: this._id }, this.client);
-        const [item] = res.data.items.map((data) => new _1.Item(this.client, { ...res, data }));
-        return item;
-    }
-    /**
-     * Get a list of Items
-     * @param params The params for the request
-     * @param params.limit The number of items to return (optional)
-     * @param params.offset The number of items to skip (optional)
-     * @returns A list of Items
-     */
-    async items({ limit, offset } = {}) {
-        const res = await _1.Item.list({ collectionId: this._id, limit, offset }, this.client);
-        return res.data.items.map((data) => new _1.Item(this.client, { ...res, data }));
-    }
-    /**
-     * Remove a single Item
-     * @param params The params for the request
-     * @param params.itemId The Item ID
-     * @returns The result from the removal
-     */
-    async removeItem({ itemId }) {
-        const res = await _1.Item.remove({ itemId, collectionId: this._id }, this.client);
-        return res.data;
-    }
-    /**
-     * Create a new Item
-     * @param fields The Item fields to create
-     * @returns The created Item
-     */
-    async createItem(fields) {
-        const res = await _1.Item.create({ collectionId: this._id, fields }, this.client);
-        return new _1.Item(this.client, res);
-    }
-    /**
-     * Update a single Item
-     * @param params The params for the request
-     * @param params.itemId The Item ID
-     * @param params.fields The fields to update
-     * @returns The updated Item
-     */
-    async updateItem({ itemId, fields }) {
-        const params = { itemId, collectionId: this._id, fields };
-        const res = await _1.Item.update(params, this.client);
-        return new _1.Item(this.client, res);
-    }
-}
-exports.Collection = Collection;

package/dist/api/index.d.ts

@@ -1,7 +0,0 @@
-export * from "./collection";
-export * from "./user";
-export * from "./webhook";
-export * from "./item";
-export * from "./site";
-export * from "./oauth";
-export * from "./meta";

package/dist/api/index.js

@@ -1,23 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./collection"), exports);
-__exportStar(require("./user"), exports);
-__exportStar(require("./webhook"), exports);
-__exportStar(require("./item"), exports);
-__exportStar(require("./site"), exports);
-__exportStar(require("./oauth"), exports);
-__exportStar(require("./meta"), exports);