webflow-api 1.3.0 → 1.3.1

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/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/tests/api/collection.test.ts

@@ -1,147 +0,0 @@
-import MockAdapter from "axios-mock-adapter";
-import axios from "axios";
-import { ItemFixture, CollectionFixture } from "../fixtures";
-import { Collection, Item } from "../../src/api";
-
-describe("Collection", () => {
-  const mock = new MockAdapter(axios);
-  const client = axios.create();
-
-  describe("Static Methods", () => {
-    it("should respond with a list of site collections", async () => {
-      const { parameters, response } = CollectionFixture.list;
-      const { siteId } = parameters;
-      const path = `/sites/${siteId}/collections`;
-
-      mock.onGet(path).reply(200, response);
-      const { data } = await Collection.list(parameters, client);
-
-      expect(data).toBeDefined();
-      expect(data.length).toBe(response.length);
-      expect(data[0]).toMatchObject(response[0]);
-    });
-
-    it("should respond with a single site collection", async () => {
-      const { parameters, response } = CollectionFixture.getOne;
-      const { collectionId } = parameters;
-      const path = `/collections/${collectionId}`;
-
-      mock.onGet(path).reply(200, response);
-      const { data } = await Collection.getOne(parameters, client);
-
-      expect(data).toBeDefined();
-      expect(data._id).toBe(response._id);
-    });
-  });
-
-  describe("Instance Methods", () => {
-    const res = { data: {}, status: 200, statusText: "", headers: {}, config: {} };
-    const collection = new Collection(client, res, CollectionFixture.getOne.response);
-
-    it("should respond with a list of items", async () => {
-      const { parameters, response } = ItemFixture.list;
-      const { collectionId } = parameters;
-
-      const path = `/collections/${collectionId}/items`;
-      mock.onGet(path).reply(200, response);
-      const spy = jest.spyOn(Item, "list");
-
-      const result = await collection.items();
-
-      const _params = { params: undefined, collectionId };
-      expect(spy).toBeCalledWith(_params, client);
-
-      expect(result).toBeDefined();
-      expect(result.length).toBe(response.items.length);
-
-      expect(result[0]._id).toBe(response.items[0]._id);
-
-      // item wrapper functions
-      expect(typeof result[0].update).toBe("function");
-      expect(typeof result[0].remove).toBe("function");
-    });
-
-    it("should respond with a single item", async () => {
-      const { parameters, response } = ItemFixture.getOne;
-      const { collectionId, itemId } = parameters;
-
-      const path = `/collections/${collectionId}/items/${itemId}`;
-      mock.onGet(path).reply(200, response);
-      const spy = jest.spyOn(Item, "getOne");
-
-      const result = await collection.item({ itemId });
-
-      const _params = { params: undefined, collectionId, itemId };
-      expect(spy).toBeCalledWith(_params, client);
-
-      expect(result).toBeDefined();
-      expect(result._id).toBe(response.items[0]._id);
-
-      // item wrapper functions
-      expect(typeof result.update).toBe("function");
-      expect(typeof result.remove).toBe("function");
-    });
-
-    it("should create an item", async () => {
-      const { parameters, response } = ItemFixture.create;
-      const { collectionId, fields } = parameters;
-
-      const path = `/collections/${collectionId}/items`;
-      mock.onPost(path).reply(200, response);
-      const spy = jest.spyOn(Item, "create");
-
-      const result = await collection.createItem(fields);
-
-      const _params = { params: undefined, collectionId, fields };
-      expect(spy).toBeCalledWith(_params, client);
-
-      expect(result).toBeDefined();
-      expect(result._id).toBe(response._id);
-
-      // item wrapper functions
-      expect(typeof result.update).toBe("function");
-      expect(typeof result.remove).toBe("function");
-    });
-
-    it("should update an item", async () => {
-      const { parameters, response } = ItemFixture.update;
-      const { collectionId, itemId, fields } = parameters;
-
-      const path = `/collections/${collectionId}/items/${itemId}`;
-      mock.onPut(path).reply(200, response);
-      const spy = jest.spyOn(Item, "update");
-
-      const result = await collection.updateItem({
-        itemId,
-        fields,
-      });
-
-      const _params = { params: undefined, collectionId, itemId, fields };
-      expect(spy).toBeCalledWith(_params, client);
-
-      expect(result).toBeDefined();
-      expect(result._id).toBe(response._id);
-
-      // item wrapper functions
-      expect(typeof result.update).toBe("function");
-      expect(typeof result.remove).toBe("function");
-    });
-
-    it("should remove an item", async () => {
-      const { parameters, response } = ItemFixture.remove;
-      const { collectionId, itemId } = parameters;
-
-      const path = `/collections/${collectionId}/items/${itemId}`;
-      mock.onDelete(path).reply(200, response);
-      const spy = jest.spyOn(Item, "remove");
-
-      const result = await collection.removeItem({ itemId });
-
-      const _params = { params: undefined, collectionId, itemId };
-      expect(spy).toBeCalledWith(_params, client);
-
-      expect(result).toBeDefined();
-      expect(result.deleted).toBe(response.deleted);
-    });
-  });
-});

package/tests/api/item.test.ts

@@ -1,180 +0,0 @@
-import MockAdapter from "axios-mock-adapter";
-import axios from "axios";
-import { ItemFixture } from "../fixtures";
-import { Item } from "../../src/api";
-
-describe("Items", () => {
-  const mock = new MockAdapter(axios);
-  const client = axios.create();
-
-  describe("Static Methods", () => {
-    it("should respond with a list of items", async () => {
-      const { parameters, response } = ItemFixture.list;
-      const { collectionId } = parameters;
-      const path = `/collections/${collectionId}/items`;
-
-      mock.onGet(path).reply(200, response);
-      const { data } = await Item.list(parameters, client);
-
-      expect(data).toBeDefined();
-      expect(data.items.length).toBe(response.items.length);
-      expect(data.items[0]).toMatchObject(response.items[0]);
-    });
-
-    it("should respond with a single item", async () => {
-      const { parameters, response } = ItemFixture.getOne;
-      const { collectionId, itemId } = parameters;
-      const path = `/collections/${collectionId}/items/${itemId}`;
-
-      mock.onGet(path).reply(200, response);
-      const { data } = await Item.getOne(parameters, client);
-
-      expect(data).toBeDefined();
-      expect(data.items[0]._id).toBe(response.items[0]._id);
-    });
-
-    it("should create an item", async () => {
-      const { parameters, response } = ItemFixture.create;
-      const { collectionId } = parameters;
-
-      const path = `/collections/${collectionId}/items`;
-
-      mock.onPost(path).reply(200, response);
-      const { data } = await Item.create(parameters, client);
-
-      expect(data).toBeDefined();
-      expect(data._id).toBe(response._id);
-    });
-
-    it("should update an item", async () => {
-      const { parameters, response } = ItemFixture.update;
-      const { collectionId, itemId } = parameters;
-      const path = `/collections/${collectionId}/items/${itemId}`;
-
-      mock.onPut(path).reply(200, response);
-      const { data } = await Item.update(parameters, client);
-
-      expect(data).toBeDefined();
-      expect(data._id).toBe(response._id);
-    });
-
-    it("should patch an item", async () => {
-      const { parameters, response } = ItemFixture.update;
-      const { collectionId, itemId } = parameters;
-      const path = `/collections/${collectionId}/items/${itemId}`;
-
-      mock.onPatch(path).reply(200, response);
-      const { data } = await Item.patch(parameters, client);
-
-      expect(data).toBeDefined();
-      expect(data._id).toBe(response._id);
-    });
-
-    it("should remove an item", async () => {
-      const { parameters, response } = ItemFixture.remove;
-      const { collectionId, itemId } = parameters;
-      const path = `/collections/${collectionId}/items/${itemId}`;
-
-      mock.onDelete(path).reply(200, response);
-      const { data } = await Item.remove(parameters, client);
-
-      expect(data).toBeDefined();
-      expect(data.deleted).toBe(response.deleted);
-    });
-
-    it("should unpublish multiple items", async () => {
-      const { parameters, response } = ItemFixture.unpublish;
-      const { collectionId, itemIds } = parameters;
-      const path = `/collections/${collectionId}/items`;
-
-      mock.onDelete(path).reply(200, response);
-      const { data } = await Item.unpublish(parameters, client);
-
-      expect(data).toBeDefined();
-      expect(data.deletedItemIds.length).toBe(itemIds.length);
-      expect(data.deletedItemIds[0]).toBe(itemIds[0]);
-    });
-
-    it("should live unpublish multiple items", async () => {
-      const { parameters, response } = ItemFixture.unpublish;
-      const { collectionId, itemIds } = parameters;
-      const path = `/collections/${collectionId}/items?live=true`;
-
-      mock.onDelete(path).reply(200, response);
-      const { data } = await Item.unpublish(parameters, client);
-
-      expect(data).toBeDefined();
-      expect(data.deletedItemIds.length).toBe(itemIds.length);
-      expect(data.deletedItemIds[0]).toBe(itemIds[0]);
-    });
-
-    it("should publish multiple items", async () => {
-      const { parameters, response } = ItemFixture.publish;
-      const { collectionId, itemIds } = parameters;
-      const path = `/collections/${collectionId}/items/publish`;
-
-      mock.onPut(path).reply(200, response);
-      const { data } = await Item.publish(parameters, client);
-
-      expect(data).toBeDefined();
-      expect(data.publishedItemIds.length).toBe(itemIds.length);
-      expect(data.publishedItemIds[0]).toBe(itemIds[0]);
-    });
-
-    it("should live publish multiple items", async () => {
-      const { parameters, response } = ItemFixture.publish;
-      const { collectionId, itemIds } = parameters;
-      const path = `/collections/${collectionId}/items/publish?live=true`;
-
-      mock.onPut(path).reply(200, response);
-      const { data } = await Item.publish(parameters, client);
-
-      expect(data).toBeDefined();
-      expect(data.publishedItemIds.length).toBe(itemIds.length);
-      expect(data.publishedItemIds[0]).toBe(itemIds[0]);
-    });
-  });
-
-  describe("Instance Methods", () => {
-    const res = { data: {}, status: 200, statusText: "", headers: {}, config: {} };
-    const item = new Item(client, res, ItemFixture.getOne.response.items[0]);
-
-    it("should update an item", async () => {
-      const { parameters, response } = ItemFixture.update;
-      const { collectionId, itemId, fields } = parameters;
-
-      const path = `/collections/${collectionId}/items/${itemId}`;
-      mock.onPut(path).reply(200, response);
-      const spy = jest.spyOn(Item, "update");
-
-      const result = await item.update(fields);
-
-      const _params = { params: undefined, collectionId, itemId, fields };
-      expect(spy).toBeCalledWith(_params, client);
-
-      expect(result).toBeDefined();
-      expect(result._id).toBe(response._id);
-
-      // item wrapper functions
-      expect(typeof result.update).toBe("function");
-      expect(typeof result.remove).toBe("function");
-    });
-
-    it("should remove an item", async () => {
-      const { parameters, response } = ItemFixture.remove;
-      const { collectionId, itemId } = parameters;
-
-      const path = `/collections/${collectionId}/items/${itemId}`;
-      mock.onDelete(path).reply(200, response);
-      const spy = jest.spyOn(Item, "remove");
-
-      const result = await item.remove();
-
-      const _params = { params: undefined, collectionId, itemId };
-      expect(spy).toBeCalledWith(_params, client);
-
-      expect(result).toBeDefined();
-      expect(result.deleted).toBe(response.deleted);
-    });
-  });
-});

package/tests/api/meta.test.ts

@@ -1,38 +0,0 @@
-import MockAdapter from "axios-mock-adapter";
-import axios from "axios";
-import { MetaFixture } from "../fixtures";
-import { Meta } from "../../src/api";
-
-describe("Meta", () => {
-  const mock = new MockAdapter(axios);
-  const client = axios.create();
-
-  it("should get info", async () => {
-    const { response } = MetaFixture.info;
-    const path = `/info`;
-
-    mock.onGet(path).reply(200, response);
-    const { data } = await Meta.info(client);
-
-    expect(data).toBeDefined();
-    expect(data.users).toEqual(response.users);
-    expect(data.sites).toEqual(response.sites);
-    expect(data.workspaces).toEqual(response.workspaces);
-    expect(data.application).toEqual(response.application);
-  });
-
-  it("should get info about the user", async () => {
-    const { response } = MetaFixture.installer;
-
-    const path = `/user`;
-    mock.onGet(path).reply(200, response);
-    const { data } = await Meta.user(client);
-
-    expect(data).toBeDefined();
-    expect(data.user).toBeDefined();
-    expect(data.user._id).toEqual(response.user._id);
-    expect(data.user.email).toEqual(response.user.email);
-    expect(data.user.firstName).toEqual(response.user.firstName);
-    expect(data.user.lastName).toEqual(response.user.lastName);
-  });
-});

package/tests/api/oauth.test.ts

@@ -1,44 +0,0 @@
-import MockAdapter from "axios-mock-adapter";
-import axios from "axios";
-import { OAuthFixture } from "../fixtures";
-import { OAuth } from "../../src/api";
-
-describe("OAuth", () => {
-  const mock = new MockAdapter(axios);
-  const client = axios.create();
-
-  it("should generate an authorization url", () => {
-    const { parameters } = OAuthFixture.authorize;
-    const { client_id, state, response_type } = parameters;
-
-    const baseURL = "https://api.test.com";
-    const instance = axios.create({ baseURL });
-    const url = OAuth.authorizeUrl({ client_id, state }, instance);
-    const query = new URLSearchParams({ response_type, client_id, state });
-
-    expect(url).toBeDefined();
-    expect(url).toBe(`${baseURL.replace("api.", "")}/oauth/authorize?${query.toString()}`);
-  });
-
-  it("should generate an access token", async () => {
-    const { parameters, response } = OAuthFixture.access_token;
-    const path = `/oauth/access_token`;
-
-    mock.onPost(path).reply(200, response);
-    const { data } = await OAuth.accessToken(parameters, client);
-
-    expect(data).toBeDefined();
-    expect(data.access_token).toBe(response.access_token);
-  });
-
-  it("should revoke an access token", async () => {
-    const { parameters, response } = OAuthFixture.revoke_token;
-    const path = `/oauth/revoke_authorization`;
-
-    mock.onPost(path).reply(200, response);
-    const { data } = await OAuth.revokeToken(parameters, client);
-
-    expect(data).toBeDefined();
-    expect(data.didRevoke).toBe(true);
-  });
-});