@superblocksteam/sdk 0.0.11

package/.eslintrc.json

@@ -0,0 +1,51 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint",
+    "prettier",
+    "import",
+    "unicorn"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+    "plugin:prettier/recommended",
+    "prettier",
+    "plugin:import/typescript"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module",
+    "project": "./tsconfig.json"
+  },
+  "rules": {
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-unused-vars": "error",
+    "@typescript-eslint/no-var-requires": "off",
+    "@typescript-eslint/no-unsafe-return": "off",
+    "@typescript-eslint/no-unsafe-member-access": "off",
+    "import/order": [
+      "error",
+      {
+        "alphabetize": { "order": "asc" },
+        "groups": [
+          "builtin",
+          "external",
+          "internal",
+          "parent",
+          "sibling",
+          "index",
+          "object",
+          "type"
+        ]
+      }
+    ],
+    "import/no-cycle": "error",
+    "no-template-curly-in-string": "off",
+    "no-useless-escape": "off",
+    "no-void": ["error", { "allowAsStatement": true }]
+  },
+  "ignorePatterns": ["public", "build", "node_modules", "dist"]
+}

package/dist/client.d.ts

@@ -0,0 +1,8 @@
+export type ViewMode = "export-deployed" | "export-latest" | "export-live";
+export declare function fetchApplication(applicationId: string, token: string, superblocksBaseUrl: string, viewMode: ViewMode): Promise<any>;
+export declare function fetchApplications(token: string, superblocksBaseUrl: string): Promise<any>;
+export declare function fetchApi(apiId: string, token: string, superblocksBaseUrl: string, viewMode: ViewMode): Promise<any>;
+export declare function fetchApis(token: string, superblocksBaseUrl: string): Promise<any>;
+export declare function registerComponents(applicationId: string, componentConfigs: Record<string, any>, token: string, superblocksBaseUrl: string): Promise<any>;
+export declare function uploadComponents(applicationId: string, componentConfigs: Record<string, any>, files: string[], token: string, superblocksBaseUrl: string): Promise<any>;
+export declare function fetchCurrentUser(token: string, superblocksBaseUrl: string): Promise<any>;

package/dist/client.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchCurrentUser = exports.uploadComponents = exports.registerComponents = exports.fetchApis = exports.fetchApi = exports.fetchApplications = exports.fetchApplication = void 0;
+const axios_1 = require("axios");
+const BASE_SERVER_URL = "api/v1";
+async function fetchApplication(applicationId, token, superblocksBaseUrl, viewMode) {
+    const url = `/api/v2/applications/${applicationId}?viewMode=${viewMode}`;
+    const config = {
+        method: "get",
+        url: new URL(url, superblocksBaseUrl).toString(),
+        headers: {
+            Authorization: "Bearer " + token,
+        },
+    };
+    const response = await (0, axios_1.default)(config);
+    if (response.status !== 200) {
+        throw new Error("Could not fetch application");
+    }
+    return response.data.data;
+}
+exports.fetchApplication = fetchApplication;
+async function fetchApplications(token, superblocksBaseUrl) {
+    const config = {
+        method: "get",
+        url: new URL(`/api/v2/applications`, superblocksBaseUrl).toString(),
+        headers: {
+            Authorization: "Bearer " + token,
+        },
+    };
+    const response = await (0, axios_1.default)(config);
+    if (response.status !== 200) {
+        throw new Error("Could not fetch applications");
+    }
+    return response.data.data.applications;
+}
+exports.fetchApplications = fetchApplications;
+async function fetchApi(apiId, token, superblocksBaseUrl, viewMode) {
+    const config = {
+        method: "get",
+        url: new URL(`/api/v3/apis/${apiId}?viewMode=${viewMode}`, superblocksBaseUrl).toString(),
+        headers: {
+            Authorization: "Bearer " + token,
+        },
+    };
+    const response = await (0, axios_1.default)(config);
+    if (response.status !== 200) {
+        throw new Error("Could not fetch api");
+    }
+    return response.data.data;
+}
+exports.fetchApi = fetchApi;
+async function fetchApis(token, superblocksBaseUrl) {
+    const config = {
+        method: "get",
+        url: new URL(`/api/v3/apis`, superblocksBaseUrl).toString(),
+        headers: {
+            Authorization: "Bearer " + token,
+        },
+    };
+    const response = await (0, axios_1.default)(config);
+    if (response.status !== 200) {
+        throw new Error("Could not fetch apis");
+    }
+    return response.data.data;
+}
+exports.fetchApis = fetchApis;
+async function registerComponents(applicationId, componentConfigs, token, superblocksBaseUrl) {
+    const config = {
+        method: "put",
+        url: new URL(`${BASE_SERVER_URL}/public/application/${applicationId}/components`, superblocksBaseUrl).toString(),
+        headers: {
+            Authorization: "Bearer " + token,
+        },
+        data: { components: componentConfigs },
+    };
+    try {
+        const response = await (0, axios_1.default)(config);
+        if (response.status !== 200) {
+            throw new Error("Could not register application components");
+        }
+        return response.data;
+    }
+    catch (e) {
+        console.error(config.url);
+        throw e;
+    }
+}
+exports.registerComponents = registerComponents;
+async function uploadComponents(applicationId, componentConfigs, files, token, superblocksBaseUrl) {
+    const config = {
+        method: "post",
+        url: new URL(`${BASE_SERVER_URL}/public/application/${applicationId}/publish`, superblocksBaseUrl).toString(),
+        headers: {
+            Authorization: "Bearer " + token,
+        },
+        data: { components: componentConfigs, files },
+    };
+    try {
+        const response = await (0, axios_1.default)(config);
+        if (response.status !== 200) {
+            throw new Error("Could not register application components");
+        }
+        return response.data;
+    }
+    catch (e) {
+        console.error(config.url);
+        throw e;
+    }
+}
+exports.uploadComponents = uploadComponents;
+async function fetchCurrentUser(token, superblocksBaseUrl) {
+    const config = {
+        method: "get",
+        url: new URL(`/api/v1/users/me`, superblocksBaseUrl).toString(),
+        headers: {
+            Authorization: "Bearer " + token,
+        },
+    };
+    const response = await (0, axios_1.default)(config);
+    if (response.status !== 200) {
+        throw new Error("Could not fetch current user");
+    }
+    return response.data.data.user;
+}
+exports.fetchCurrentUser = fetchCurrentUser;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./client";
+export * from "./sdk";

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./client"), exports);
+tslib_1.__exportStar(require("./sdk"), exports);

package/dist/sdk.d.ts

@@ -0,0 +1,13 @@
+import { ViewMode } from "./client";
+export declare class SuperblocksSdk {
+    token: string;
+    superblocksBaseUrl: string;
+    constructor(accessToken: string, superblocksBaseUrl: string);
+    fetchApplication(applicationId: string, viewMode?: ViewMode): Promise<any>;
+    fetchApplications(): Promise<any>;
+    fetchApi(apiId: string, viewMode?: ViewMode): Promise<any>;
+    fetchApis(): Promise<any>;
+    registerComponents(applicationId: string, componentConfigs: Record<string, any>): Promise<any>;
+    uploadComponents(applicationId: string, componentConfigs: Record<string, any>, files: string[]): Promise<any>;
+    fetchCurrentUser(): Promise<any>;
+}

package/dist/sdk.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SuperblocksSdk = void 0;
+const client_1 = require("./client");
+class SuperblocksSdk {
+    constructor(accessToken, superblocksBaseUrl) {
+        this.token = "";
+        this.superblocksBaseUrl = "";
+        this.token = accessToken;
+        this.superblocksBaseUrl = superblocksBaseUrl;
+    }
+    async fetchApplication(applicationId, viewMode = "export-live") {
+        return (0, client_1.fetchApplication)(applicationId, this.token, this.superblocksBaseUrl, viewMode);
+    }
+    async fetchApplications() {
+        return (0, client_1.fetchApplications)(this.token, this.superblocksBaseUrl);
+    }
+    async fetchApi(apiId, viewMode = "export-live") {
+        return (0, client_1.fetchApi)(apiId, this.token, this.superblocksBaseUrl, viewMode);
+    }
+    async fetchApis() {
+        return (0, client_1.fetchApis)(this.token, this.superblocksBaseUrl);
+    }
+    async registerComponents(applicationId, componentConfigs) {
+        return (0, client_1.registerComponents)(applicationId, componentConfigs, this.token, this.superblocksBaseUrl);
+    }
+    async uploadComponents(applicationId, componentConfigs, files) {
+        return (0, client_1.uploadComponents)(applicationId, componentConfigs, files, this.token, this.superblocksBaseUrl);
+    }
+    async fetchCurrentUser() {
+        return (0, client_1.fetchCurrentUser)(this.token, this.superblocksBaseUrl);
+    }
+}
+exports.SuperblocksSdk = SuperblocksSdk;

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@superblocksteam/sdk",
+  "version": "0.0.11",
+  "description": "Superblocks JS SDK",
+  "main": "./dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/sdk.mjs",
+      "require": "./dist/sdk.js",
+      "types": "./dist/sdk.d.ts"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "dev": "tsc --watch",
+    "build": "tsc --build",
+    "clean": "npm run clean:build && rm -rf node_modules",
+    "clean:build": "tsc --build --clean && rm -rf dist tsconfig.tsbuildinfo",
+    "lint": "eslint . --ext .ts --config .eslintrc.json",
+    "lint:fix": "eslint . --ext .ts --config .eslintrc.json --fix"
+  },
+  "license": "Superblocks Community Software License",
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.60.1",
+    "@typescript-eslint/parser": "^5.60.1",
+    "eslint": "^8.45.0",
+    "eslint-plugin-unicorn": "^47.0.0",
+    "prettier": "^2.8.8",
+    "typescript": "^5.1.3"
+  },
+  "dependencies": {
+    "axios": "^1.3.5"
+  },
+  "homepage": "https://www.superblocks.com",
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}

package/src/client.ts

@@ -0,0 +1,173 @@
+import axios from "axios";
+
+const BASE_SERVER_URL = "api/v1";
+
+export type ViewMode = "export-deployed" | "export-latest" | "export-live";
+
+export async function fetchApplication(
+  applicationId: string,
+  token: string,
+  superblocksBaseUrl: string,
+  viewMode: ViewMode
+) {
+  const url = `/api/v2/applications/${applicationId}?viewMode=${viewMode}`;
+  const config = {
+    method: "get",
+    url: new URL(url, superblocksBaseUrl).toString(),
+    headers: {
+      Authorization: "Bearer " + token,
+    },
+  };
+
+  const response = await axios(config);
+  if (response.status !== 200) {
+    throw new Error("Could not fetch application");
+  }
+
+  return response.data.data;
+}
+
+export async function fetchApplications(
+  token: string,
+  superblocksBaseUrl: string
+) {
+  const config = {
+    method: "get",
+    url: new URL(`/api/v2/applications`, superblocksBaseUrl).toString(),
+    headers: {
+      Authorization: "Bearer " + token,
+    },
+  };
+
+  const response = await axios(config);
+  if (response.status !== 200) {
+    throw new Error("Could not fetch applications");
+  }
+
+  return response.data.data.applications;
+}
+
+export async function fetchApi(
+  apiId: string,
+  token: string,
+  superblocksBaseUrl: string,
+  viewMode: ViewMode
+) {
+  const config = {
+    method: "get",
+    url: new URL(
+      `/api/v3/apis/${apiId}?viewMode=${viewMode}`,
+      superblocksBaseUrl
+    ).toString(),
+    headers: {
+      Authorization: "Bearer " + token,
+    },
+  };
+
+  const response = await axios(config);
+  if (response.status !== 200) {
+    throw new Error("Could not fetch api");
+  }
+
+  return response.data.data;
+}
+
+export async function fetchApis(token: string, superblocksBaseUrl: string) {
+  const config = {
+    method: "get",
+    url: new URL(`/api/v3/apis`, superblocksBaseUrl).toString(),
+    headers: {
+      Authorization: "Bearer " + token,
+    },
+  };
+
+  const response = await axios(config);
+  if (response.status !== 200) {
+    throw new Error("Could not fetch apis");
+  }
+
+  return response.data.data;
+}
+
+export async function registerComponents(
+  applicationId: string,
+  componentConfigs: Record<string, any>,
+  token: string,
+  superblocksBaseUrl: string
+) {
+  const config = {
+    method: "put",
+    url: new URL(
+      `${BASE_SERVER_URL}/public/application/${applicationId}/components`,
+      superblocksBaseUrl
+    ).toString(),
+    headers: {
+      Authorization: "Bearer " + token,
+    },
+    data: { components: componentConfigs },
+  };
+
+  try {
+    const response = await axios(config);
+    if (response.status !== 200) {
+      throw new Error("Could not register application components");
+    }
+
+    return response.data;
+  } catch (e) {
+    console.error(config.url);
+    throw e;
+  }
+}
+
+export async function uploadComponents(
+  applicationId: string,
+  componentConfigs: Record<string, any>,
+  files: string[],
+  token: string,
+  superblocksBaseUrl: string
+) {
+  const config = {
+    method: "post",
+    url: new URL(
+      `${BASE_SERVER_URL}/public/application/${applicationId}/publish`,
+      superblocksBaseUrl
+    ).toString(),
+    headers: {
+      Authorization: "Bearer " + token,
+    },
+    data: { components: componentConfigs, files },
+  };
+
+  try {
+    const response = await axios(config);
+    if (response.status !== 200) {
+      throw new Error("Could not register application components");
+    }
+
+    return response.data;
+  } catch (e) {
+    console.error(config.url);
+    throw e;
+  }
+}
+
+export async function fetchCurrentUser(
+  token: string,
+  superblocksBaseUrl: string
+) {
+  const config = {
+    method: "get",
+    url: new URL(`/api/v1/users/me`, superblocksBaseUrl).toString(),
+    headers: {
+      Authorization: "Bearer " + token,
+    },
+  };
+
+  const response = await axios(config);
+  if (response.status !== 200) {
+    throw new Error("Could not fetch current user");
+  }
+
+  return response.data.data.user;
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./client";
+export * from "./sdk";

package/src/sdk.ts

@@ -0,0 +1,74 @@
+import {
+  fetchApi,
+  fetchApis,
+  fetchApplication,
+  fetchApplications,
+  registerComponents,
+  uploadComponents,
+  fetchCurrentUser,
+  ViewMode,
+} from "./client";
+
+export class SuperblocksSdk {
+  token = "";
+  superblocksBaseUrl = "";
+
+  constructor(accessToken: string, superblocksBaseUrl: string) {
+    this.token = accessToken;
+    this.superblocksBaseUrl = superblocksBaseUrl;
+  }
+
+  async fetchApplication(
+    applicationId: string,
+    viewMode: ViewMode = "export-live"
+  ) {
+    return fetchApplication(
+      applicationId,
+      this.token,
+      this.superblocksBaseUrl,
+      viewMode
+    );
+  }
+
+  async fetchApplications() {
+    return fetchApplications(this.token, this.superblocksBaseUrl);
+  }
+
+  async fetchApi(apiId: string, viewMode: ViewMode = "export-live") {
+    return fetchApi(apiId, this.token, this.superblocksBaseUrl, viewMode);
+  }
+
+  async fetchApis() {
+    return fetchApis(this.token, this.superblocksBaseUrl);
+  }
+
+  async registerComponents(
+    applicationId: string,
+    componentConfigs: Record<string, any>
+  ) {
+    return registerComponents(
+      applicationId,
+      componentConfigs,
+      this.token,
+      this.superblocksBaseUrl
+    );
+  }
+
+  async uploadComponents(
+    applicationId: string,
+    componentConfigs: Record<string, any>,
+    files: string[]
+  ) {
+    return uploadComponents(
+      applicationId,
+      componentConfigs,
+      files,
+      this.token,
+      this.superblocksBaseUrl
+    );
+  }
+
+  async fetchCurrentUser() {
+    return fetchCurrentUser(this.token, this.superblocksBaseUrl);
+  }
+}

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "importHelpers": true,
+    "module": "commonjs",
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "target": "es2019"
+  },
+  "include": ["src/**/*"]
+}