webflow-api 1.3.0 → 2.0.0-beta

package/.eslintrc

@@ -1,31 +0,0 @@
-{
-  "env": {
-    "es2021": true,
-    "browser": true
-  },
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:@typescript-eslint/recommended-requiring-type-checking"
-  ],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": 12,
-    "project": "tsconfig.eslint.json"
-  },
-  "plugins": ["@typescript-eslint", "prettier"],
-  "rules": {
-    "prefer-const": "error",
-    "prettier/prettier": "error",
-    "@typescript-eslint/no-unused-vars": "off",
-    "@typescript-eslint/no-unused-params": "off",
-    "@typescript-eslint/no-unsafe-argument": "warn",
-    "@typescript-eslint/no-unsafe-assignment": "warn"
-  },
-  "overrides": [
-    {
-      "env": { "jest": true, "node": true },
-      "files": ["tests/**/*.ts"]
-    }
-  ]
-}

package/.github/workflows/code-quality.yml

@@ -1,102 +0,0 @@
-name: Code Quality
-
-on: push
-
-jobs:
-  build:
-    name: TypeScript Build
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Install Node.js
-        uses: actions/setup-node@v1
-        with:
-          node-version: 14.x
-
-      - name: yarn install
-        run: yarn install
-
-      - run: yarn build
-        name: yarn build
-
-  typecheck:
-    name: TypeScript Typecheck
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Install Node.js
-        uses: actions/setup-node@v1
-        with:
-          node-version: 14.x
-
-      - name: yarn install
-        run: yarn install
-
-      - run: yarn typecheck
-        name: yarn typecheck
-
-  test:
-    name: Jest CI Tests
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Install Node.js
-        uses: actions/setup-node@v1
-        with:
-          node-version: 14.x
-
-      - name: yarn install
-        run: yarn install
-
-      - name: yarn build
-        run: yarn build
-
-      - run: yarn test:ci
-        name: yarn test:ci
-
-  prettier:
-    name: Prettier Formatting
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Install Node.js
-        uses: actions/setup-node@v1
-        with:
-          node-version: 14.x
-
-      - name: yarn install
-        run: yarn install
-
-      - run: yarn format:check
-        name: yarn format:check
-
-  lint:
-    name: ESLint Linting
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Install Node.js
-        uses: actions/setup-node@v1
-        with:
-          node-version: 14.x
-
-      - name: yarn install
-        run: yarn install
-
-      - run: yarn lint
-        name: yarn lint

package/.github/workflows/npm-publish.yml

@@ -1,21 +0,0 @@
-name: Publish to NPM
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  publish-npm:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          registry-url: https://registry.npmjs.org/
-      - run: |
-          yarn install
-          yarn test
-          yarn publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/.github/workflows/semgrep.yml

@@ -1,24 +0,0 @@
-on:
-  workflow_dispatch: {}
-  pull_request: {}
-  push:
-    branches:
-      - main
-      - master
-    paths:
-      - .github/workflows/semgrep.yml
-  schedule:
-    # random HH:MM to avoid a load spike on GitHub Actions at 00:00
-    - cron: 34 11 * * *
-name: Semgrep
-jobs:
-  semgrep:
-    name: semgrep/ci
-    runs-on: ubuntu-20.04
-    env:
-      SEMGREP_APP_TOKEN: ${{ secrets.SEMGREP_APP_TOKEN }}
-    container:
-      image: returntocorp/semgrep
-    steps:
-      - uses: actions/checkout@v3
-      - run: semgrep ci

package/.prettierignore

@@ -1,5 +0,0 @@
-dist
-temp
-*.json
-coverage
-.DS_Store

package/.prettierrc

@@ -1,6 +0,0 @@
-{
-  "semi": true,
-  "useTabs": false,
-  "printWidth": 100,
-  "trailingComma": "all"
-}

package/LICENSE

@@ -1,21 +0,0 @@
-Copyright (c) 2016 Webflow, Inc
-
-Permission  is  hereby granted, free of charge, to any person ob-
-taining a copy of  this  software  and  associated  documentation
-files  (the "Software"), to deal in the Software without restric-
-tion, including without limitation the rights to use, copy, modi-
-fy, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is  fur-
-nished to do so, subject to the following conditions:
-
-The  above  copyright  notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF  ANY  KIND,
-EXPRESS  OR  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE  AND  NONIN-
-FRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER  IN  AN
-ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN  THE
-SOFTWARE.

package/jest.config.js

@@ -1,17 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-module.exports = {
-  // A preset that is used as a base for Jest's configuration
-  preset: "ts-jest",
-
-  // The test environment that will be used for testing
-  testEnvironment: "node",
-
-  // A map from regular expressions to paths to transformers
-  transform: { "^.+\\.ts?$": "ts-jest" },
-
-  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
-  transformIgnorePatterns: ["<rootDir>/node_modules/"],
-
-  // Automatically clear mock calls, instances, contexts and results before every test
-  clearMocks: true,
-};

package/src/api/collection.ts

@@ -1,154 +0,0 @@
-import { AxiosInstance } from "axios";
-import { requireArgs, WebflowRecord } from "../core";
-import { Item } from ".";
-
-/**************************************************************
- * Types
- **************************************************************/
-export type CollectionFieldType =
-  | "Bool"
-  | "Color"
-  | "Date"
-  | "ExtFileRef"
-  | "Set"
-  | "ImageRef"
-  | "Set"
-  | "ItemRef"
-  | "ItemRefSet"
-  | "Link"
-  | "Number"
-  | "Option"
-  | "PlainText"
-  | "RichText"
-  | "Video"
-  | "User"
-  | string;
-
-export type CollectionField = {
-  id: string;
-  type: CollectionFieldType;
-  slug: string;
-  name: string;
-  required: boolean;
-  editable: boolean;
-  // TODO: add a better type
-  validations?: Record<string, any>;
-};
-
-/**************************************************************
- * Interfaces
- **************************************************************/
-export interface ICollection {
-  _id: string;
-  lastUpdated: string;
-  createdOn: string;
-  name: string;
-  slug: string;
-  singularName: string;
-  fields: CollectionField[];
-}
-
-/**************************************************************
- * Class
- **************************************************************/
-export 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) {
-    requireArgs({ siteId });
-    const path = `/sites/${siteId}/collections`;
-    return client.get<ICollection[]>(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 }: { collectionId: string }, client: AxiosInstance) {
-    requireArgs({ collectionId });
-    const path = `/collections/${collectionId}`;
-    return client.get<ICollection>(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 }: { itemId: string }) {
-    const res = await Item.getOne({ itemId, collectionId: this._id }, this.client);
-    const [item] = res.data.items.map((data) => new 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 }: { limit?: number; offset?: number } = {}) {
-    const res = await Item.list({ collectionId: this._id, limit, offset }, this.client);
-    return res.data.items.map((data) => new 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 }: { itemId: string }) {
-    const res = await 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: object) {
-    const res = await Item.create({ collectionId: this._id, fields }, this.client);
-    return new 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 }: { itemId: string; fields: object }) {
-    const params = { itemId, collectionId: this._id, fields };
-    const res = await Item.update(params, this.client);
-    return new Item(this.client, res);
-  }
-}

package/src/api/index.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/src/api/item.ts

@@ -1,272 +0,0 @@
-import { AxiosInstance } from "axios";
-import { PaginatedData, requireArgs, WebflowRecord } from "../core";
-
-/**************************************************************
- * Interfaces
- **************************************************************/
-export interface IItem {
-  _archived: boolean;
-  _draft: boolean;
-  _id: string;
-  _cid: string;
-  name: string;
-  slug: string;
-  "updated-on": string;
-  "created-on": string;
-  "updated-by": string;
-  "created-by": string;
-  "published-on"?: string | null;
-  "published-by"?: string | null;
-}
-
-export interface IItemDelete {
-  deleted: number;
-}
-
-export interface IPublishItems {
-  publishedItemIds: string[];
-  errors: string[];
-}
-
-export interface IDeletedItems {
-  deletedItemIds: string[];
-  errors: string[];
-}
-
-/**************************************************************
- * Types
- **************************************************************/
-export type PaginatedItems = PaginatedData & {
-  items: IItem[];
-};
-
-/**************************************************************
- * Class
- **************************************************************/
-
-export class Item extends WebflowRecord<IItem> implements IItem {
-  "published-on"?: string | null;
-  "published-by"?: string | null;
-  "updated-on": string;
-  "created-on": string;
-  "updated-by": string;
-  "created-by": string;
-  _archived: boolean;
-  _draft: boolean;
-  _cid: string;
-  name: string;
-  slug: string;
-  _id: string;
-
-  /**************************************************************
-   * Static Methods
-   **************************************************************/
-
-  /**
-   * Get a single Item
-   * @param params The params for the request
-   * @param params.collectionId The Collection ID
-   * @param params.itemId The Item ID
-   * @param client The Axios client instance
-   * @returns A single Item
-   */
-  static getOne(
-    { collectionId, itemId }: { collectionId: string; itemId: string },
-    client: AxiosInstance,
-  ) {
-    requireArgs({ collectionId, itemId });
-    const path = `/collections/${collectionId}/items/${itemId}`;
-    // The API returns a paginated list with one record :(
-    return client.get<PaginatedItems>(path);
-  }
-
-  /**
-   * Get a list of Items
-   * @param params The params for the request
-   * @param params.collectionId The Collection ID
-   * @param params.limit The number of items to return (optional)
-   * @param params.offset The number of items to skip (optional)
-   * @param client The Axios client instance
-   * @returns A list of Items
-   */
-  static list(
-    { collectionId, limit, offset }: { collectionId: string; limit?: number; offset?: number },
-    client: AxiosInstance,
-  ) {
-    requireArgs({ collectionId });
-    const params = { limit, offset };
-    const path = `/collections/${collectionId}/items`;
-    return client.get<PaginatedItems>(path, { params });
-  }
-
-  /**
-   * Create a new Item
-   * @param params The params for the request
-   * @param params.collectionId The Collection ID
-   * @param params.fields The Item fields to create
-   * @param client The Axios client instance
-   * @returns The created Item
-   */
-  static create(
-    { collectionId, fields }: { fields: any; collectionId: string },
-    client: AxiosInstance,
-  ) {
-    requireArgs({ collectionId });
-    const path = `/collections/${collectionId}/items`;
-    return client.post<IItem>(path, { fields });
-  }
-
-  /**
-   * Update a single Item
-   * @param params The params for the request
-   * @param params.collectionId The Collection ID
-   * @param params.itemId The Item ID
-   * @param params.fields The fields to update
-   * @param client The Axios client instance
-   * @returns The updated Item
-   */
-  static update(
-    {
-      collectionId,
-      itemId,
-      fields,
-    }: {
-      fields: any;
-      itemId: string;
-      collectionId: string;
-    },
-    client: AxiosInstance,
-  ) {
-    requireArgs({ collectionId, itemId });
-    const path = `/collections/${collectionId}/items/${itemId}`;
-    return client.put<IItem>(path, { fields });
-  }
-
-  /**
-   * Patch a single Item
-   * @param params The params for the request
-   * @param params.collectionId The Collection ID
-   * @param params.itemId The Item ID
-   * @param params.fields The fields to patch
-   * @param client The Axios client instance
-   * @returns The patched Item
-   */
-  static patch(
-    {
-      collectionId,
-      itemId,
-      fields,
-    }: {
-      fields: any;
-      itemId: string;
-      collectionId: string;
-    },
-    client: AxiosInstance,
-  ) {
-    requireArgs({ collectionId, itemId });
-    const path = `/collections/${collectionId}/items/${itemId}`;
-    return client.patch<IItem>(path, { fields });
-  }
-
-  /**
-   * Remove a single Item
-   * @param params The params for the request
-   * @param params.collectionId The Collection ID
-   * @param params.itemId The Item ID
-   * @param client The Axios client instance
-   * @returns The result from the removal
-   */
-  static remove(
-    {
-      collectionId,
-      itemId,
-    }: {
-      itemId: string;
-      collectionId: string;
-    },
-    client: AxiosInstance,
-  ) {
-    requireArgs({ collectionId, itemId });
-    const path = `/collections/${collectionId}/items/${itemId}`;
-    return client.delete<IItemDelete>(path);
-  }
-
-  /**
-   * Unpublish a list of Items
-   * @param params The params for the request
-   * @param params.collectionId The Collection ID
-   * @param params.live Unpublish from the live site
-   * @param client The Axios client instance
-   * @returns The result of the unpublish
-   */
-  static unpublish(
-    {
-      collectionId,
-      itemIds,
-      live = false,
-    }: {
-      live?: boolean;
-      itemIds: string[];
-      collectionId: string;
-    },
-    client: AxiosInstance,
-  ) {
-    requireArgs({ collectionId, itemIds });
-    const params = { live };
-    const data = { itemIds };
-    const url = `/collections/${collectionId}/items`;
-    const _params = { method: "DELETE", url, data, params };
-
-    // DELETE spec doesn't support body in delete
-    // RFC-9110 https://tools.ietf.org/html/rfc9110
-    return client.request<IDeletedItems>(_params);
-  }
-
-  /**
-   * Publishes a list of Items
-   * @param params The request parameters
-   * @param params.collectionId The Collection ID
-   * @param params.itemIds The list of Item IDs to publish
-   * @param params.live Publish to live site
-   * @param client The Axios client instance
-   * @returns The result of the publish
-   */
-  static publish(
-    {
-      itemIds,
-      live = false,
-      collectionId,
-    }: { live?: boolean; itemIds: string[]; collectionId: string },
-    client: AxiosInstance,
-  ) {
-    requireArgs({ collectionId, itemIds });
-    const params = { live };
-    const path = `/collections/${collectionId}/items/publish`;
-    return client.put<IPublishItems>(path, { itemIds }, { params });
-  }
-
-  /**************************************************************
-   * Instance Methods
-   **************************************************************/
-
-  /**
-   * Update a single Item
-   * @param fields The fields to update
-   * @returns The updated Item
-   */
-  async update({ ...fields }) {
-    const params = { collectionId: this._cid, itemId: this._id, fields };
-    const res = await Item.update(params, this.client);
-    return new Item(this.client, res);
-  }
-
-  /**
-   * Remove a single Item
-   * @returns The result from the removal
-   */
-  async remove() {
-    const params = { collectionId: this._cid, itemId: this._id };
-    const res = await Item.remove(params, this.client);
-    return res.data;
-  }
-}