@space-df/sdk 0.0.1-dev.3.3 → 0.0.1-dev.4

package/dist/src/shims/web.ts

@@ -0,0 +1,50 @@
+// @ts-ignore
+import * as types from '../_shims/web-types';
+import { setShims } from '../_shims/registry';
+import { getRuntime } from '../_shims/web-runtime';
+setShims(getRuntime({ manuallyImported: true }));
+
+declare module '../_shims/manual-types' {
+    export namespace manual {
+        // @ts-ignore
+        export type Agent = types.Agent;
+        // @ts-ignore
+        export import fetch = types.fetch;
+        // @ts-ignore
+        export type Request = types.Request;
+        // @ts-ignore
+        export type RequestInfo = types.RequestInfo;
+        // @ts-ignore
+        export type RequestInit = types.RequestInit;
+        // @ts-ignore
+        export type Response = types.Response;
+        // @ts-ignore
+        export type ResponseInit = types.ResponseInit;
+        // @ts-ignore
+        export type ResponseType = types.ResponseType;
+        // @ts-ignore
+        export type BodyInit = types.BodyInit;
+        // @ts-ignore
+        export type Headers = types.Headers;
+        // @ts-ignore
+        export type HeadersInit = types.HeadersInit;
+        // @ts-ignore
+        export type BlobPropertyBag = types.BlobPropertyBag;
+        // @ts-ignore
+        export type FilePropertyBag = types.FilePropertyBag;
+        // @ts-ignore
+        export type FileFromPathOptions = types.FileFromPathOptions;
+        // @ts-ignore
+        export import FormData = types.FormData;
+        // @ts-ignore
+        export import File = types.File;
+        // @ts-ignore
+        export import Blob = types.Blob;
+        // @ts-ignore
+        export type Readable = types.Readable;
+        // @ts-ignore
+        export type FsReadStream = types.FsReadStream;
+        // @ts-ignore
+        export import ReadableStream = types.ReadableStream;
+    }
+}

package/dist/src/types/api.ts

@@ -0,0 +1,31 @@
+export interface ListResponse<T> {
+    count: number;
+
+    results: Array<T>;
+
+    next?: string | null;
+
+    previous?: string | null;
+}
+
+export interface ListParamsResponse {
+    /**
+     * Number of results to return per page.
+     */
+    limit?: number;
+
+    /**
+     * The initial index from which to return the results.
+     */
+    offset?: number;
+
+    /**
+     * Which field to use when ordering the results.
+     */
+    ordering?: string;
+
+    /**
+     * A search term.
+     */
+    search?: string;
+}

package/dist/src/types/jwt.ts

@@ -0,0 +1,12 @@
+export type JWK = {
+    kty: 'EC' | 'RSA' | 'oct';
+    crv?: 'P-256' | 'P-384' | 'P-521';
+    x?: string;
+    y?: string;
+    e?: string;
+    n?: string;
+    use?: 'sig' | 'enc';
+    kid?: string;
+    alg?: string;
+    ext?: boolean;
+};

package/dist/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '0.0.1-dev.4';

package/dist/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.0.1-dev.4";
+//# sourceMappingURL=version.d.ts.map

package/dist/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,gBAAgB,CAAC"}

package/{version.js → dist/version.js}

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.0.1-dev.3.1';
+exports.VERSION = '0.0.1-dev.4';
 //# sourceMappingURL=version.js.map

package/dist/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,aAAa,CAAC"}

package/dist/version.mjs

@@ -0,0 +1,2 @@
+export const VERSION = '0.0.1-dev.4';
+//# sourceMappingURL=version.mjs.map

package/{version.mjs.map → dist/version.mjs.map}

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,eAAe,CAAC"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,aAAa,CAAC"}

package/eslint.config.mjs

@@ -0,0 +1,33 @@
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+import tsEslint from 'typescript-eslint';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+
+const globalsConfig = {
+    ...globals.node,
+    ...globals.jest,
+};
+
+const rules = {
+    'no-empty': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/ban-ts-comment': 'off',
+};
+
+const local = {
+    files: ['src/_shims/**/*.ts', 'src/shims/*.ts', 'src/*.ts'],
+    rules: {
+        '@typescript-eslint/no-unused-vars': 'off',
+        '@typescript-eslint/no-namespace': 'off',
+    },
+};
+export default [
+    { languageOptions: { globals: globalsConfig } },
+    pluginJs.configs.recommended,
+    ...tsEslint.configs.recommended,
+    eslintPluginPrettierRecommended,
+    { rules },
+    {
+        ...local,
+    },
+];

package/examples/auth/login.ts

@@ -0,0 +1,14 @@
+import SpaceDFSDK from '@space-df/sdk';
+
+const client = new SpaceDFSDK({ organization: 'abc' });
+
+async function main() {
+    const login = await client.auth.login({
+        email: 'test@digitalfortress.dev',
+        password: '123123',
+    });
+
+    console.log('LOGIN response', login);
+}
+
+main();

package/examples/auth/register.ts

@@ -0,0 +1,15 @@
+import SpaceDFSDK from 'spacedf-sdk';
+
+const client = new SpaceDFSDK();
+
+async function main() {
+    const register = await client.auth.register({
+        email: 'abc@digitalfortress.dev',
+        password: '123123',
+        first_name: 'abc',
+    });
+
+    console.log('Register response', register);
+}
+
+main();

package/examples/console/oauth2.ts

@@ -0,0 +1,15 @@
+import SpaceDFSDK from 'spacedf-sdk';
+
+const client = new SpaceDFSDK({ organization: 'abc' });
+
+async function main() {
+    const oauth2 = await client.oauth2.authorize({
+        client_id: 'abc',
+        redirect_uri: 'http://localhost:3000',
+        scopes: ['organization'],
+    });
+
+    console.log('oauth2 response', oauth2);
+}
+
+main();

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@space-df/sdk",
-  "version": "0.0.1-dev.3.3",
+  "version": "0.0.1-dev.4",
   "description": "The official TypeScript library for the Spacedf SDK API",
   "author": "Spacedf SDK <support@digitalfortress.dev>",
-  "types": "./index.d.ts",
-  "main": "./index.js",
+  "types": "dist/index.d.ts",
+  "main": "dist/index.js",
   "type": "commonjs",
   "repository": "git@github.com:Space-DF/spacedf-sdk-node.git",
   "license": "Apache-2.0",
@@ -20,7 +20,6 @@
     "lint": "eslint \"{src,test}/**/*.ts\""
   },
   "dependencies": {
-    "@space-df/sdk": "^0.0.1-dev.3.2",
     "@types/node": "^18.11.18",
     "@types/node-fetch": "^2.6.4",
     "abort-controller": "^3.0.0",
@@ -29,6 +28,23 @@
     "formdata-node": "^4.3.2",
     "node-fetch": "^2.6.7"
   },
+  "devDependencies": {
+    "@eslint/js": "^9.12.0",
+    "@typescript-eslint/eslint-plugin": "^6.7.0",
+    "@typescript-eslint/parser": "^6.7.0",
+    "eslint": "^8.57.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-unused-imports": "^3.0.0",
+    "globals": "^15.11.0",
+    "prettier": "^3.0.0",
+    "ts-morph": "^19.0.0",
+    "ts-node": "^10.5.0",
+    "tsc-multi": "^1.1.0",
+    "tsconfig-paths": "^4.0.0",
+    "typescript": "^4.8.2",
+    "typescript-eslint": "^8.8.1"
+  },
   "sideEffects": [
     "./_shims/index.js",
     "./_shims/index.mjs",
@@ -44,59 +60,59 @@
   "exports": {
     "./_shims/auto/*": {
       "deno": {
-        "types": "./_shims/auto/*.d.ts",
-        "require": "./_shims/auto/*.js",
-        "default": "./_shims/auto/*.mjs"
+        "types": "./dist/_shims/auto/*.d.ts",
+        "require": "./dist/_shims/auto/*.js",
+        "default": "./dist/_shims/auto/*.mjs"
       },
       "bun": {
-        "types": "./_shims/auto/*.d.ts",
-        "require": "./_shims/auto/*-bun.js",
-        "default": "./_shims/auto/*-bun.mjs"
+        "types": "./dist/_shims/auto/*.d.ts",
+        "require": "./dist/_shims/auto/*-bun.js",
+        "default": "./dist/_shims/auto/*-bun.mjs"
       },
       "browser": {
-        "types": "./_shims/auto/*.d.ts",
-        "require": "./_shims/auto/*.js",
-        "default": "./_shims/auto/*.mjs"
+        "types": "./dist/_shims/auto/*.d.ts",
+        "require": "./dist/_shims/auto/*.js",
+        "default": "./dist/_shims/auto/*.mjs"
       },
       "worker": {
-        "types": "./_shims/auto/*.d.ts",
-        "require": "./_shims/auto/*.js",
-        "default": "./_shims/auto/*.mjs"
+        "types": "./dist/_shims/auto/*.d.ts",
+        "require": "./dist/_shims/auto/*.js",
+        "default": "./dist/_shims/auto/*.mjs"
       },
       "workerd": {
-        "types": "./_shims/auto/*.d.ts",
-        "require": "./_shims/auto/*.js",
-        "default": "./_shims/auto/*.mjs"
+        "types": "./dist/_shims/auto/*.d.ts",
+        "require": "./dist/_shims/auto/*.js",
+        "default": "./dist/_shims/auto/*.mjs"
       },
       "node": {
-        "types": "./_shims/auto/*-node.d.ts",
-        "require": "./_shims/auto/*-node.js",
-        "default": "./_shims/auto/*-node.mjs"
+        "types": "./dist/_shims/auto/*-node.d.ts",
+        "require": "./dist/_shims/auto/*-node.js",
+        "default": "./dist/_shims/auto/*-node.mjs"
       },
-      "types": "./_shims/auto/*.d.ts",
-      "require": "./_shims/auto/*.js",
-      "default": "./_shims/auto/*.mjs"
+      "types": "./dist/_shims/auto/*.d.ts",
+      "require": "./dist/_shims/auto/*.js",
+      "default": "./dist/_shims/auto/*.mjs"
     },
     ".": {
       "require": {
-        "types": "./index.d.ts",
-        "default": "./index.js"
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
       },
-      "types": "./index.d.mts",
-      "default": "./index.mjs"
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
     },
     "./*.mjs": {
-      "types": "./*.d.ts",
-      "default": "./*.mjs"
+      "types": "./dist/*.d.ts",
+      "default": "./dist/*.mjs"
     },
     "./*.js": {
-      "types": "./*.d.ts",
-      "default": "./*.js"
+      "types": "./dist/*.d.ts",
+      "default": "./dist/*.js"
     },
     "./*": {
-      "types": "./*.d.ts",
-      "require": "./*.js",
-      "default": "./*.mjs"
+      "types": "./dist/*.d.ts",
+      "require": "./dist/*.js",
+      "default": "./dist/*.mjs"
     }
   }
 }

package/scripts/build

@@ -0,0 +1,56 @@
+#!/usr/bin/env bash
+
+set -exuo pipefail
+
+cd "$(dirname "$0")/.."
+
+node scripts/utils/check-version.cjs
+
+# Build into dist and will publish the package from there,
+# so that src/resources/foo.ts becomes <package root>/resources/foo.js
+# This way importing from `"@space-df/sdk/resources/foo"` works
+# even with `"moduleResolution": "node"`
+
+rm -rf dist; mkdir dist
+# Copy src to dist/src and build from dist/src into dist, so that
+# the source map for index.js.map will refer to ./src/index.ts etc
+cp -rp src README.md dist
+rm dist/src/_shims/*-deno.ts dist/src/_shims/auto/*-deno.ts
+for file in LICENSE CHANGELOG.md; do
+  if [ -e "${file}" ]; then cp "${file}" dist; fi
+done
+if [ -e "bin/cli" ]; then
+  mkdir dist/bin
+  cp -p "bin/cli" dist/bin/;
+fi
+# this converts the export map paths for the dist directory
+# and does a few other minor things
+node scripts/utils/make-dist-package-json.cjs > dist/package.json
+
+# build to .js/.mjs/.d.ts files
+npm exec tsc-multi
+# copy over handwritten .js/.mjs/.d.ts files
+cp src/_shims/*.{d.ts,js,mjs,md} dist/_shims
+cp src/_shims/auto/*.{d.ts,js,mjs} dist/_shims/auto
+# we need to add exports = module.exports = Spacedf SDK Node to index.js;
+# No way to get that from index.ts because it would cause compile errors
+# when building .mjs
+node scripts/utils/fix-index-exports.cjs
+# with "moduleResolution": "nodenext", if ESM resolves to index.d.ts,
+# it'll have TS errors on the default import.  But if it resolves to
+# index.d.mts the default import will work (even though both files have
+# the same export default statement)
+cp dist/index.d.ts dist/index.d.mts
+cp tsconfig.dist-src.json dist/src/tsconfig.json
+
+node scripts/utils/postprocess-files.cjs
+
+# make sure that nothing crashes when we require the output CJS or
+# import the output ESM
+(cd dist && node -e 'require("@space-df/sdk")')
+(cd dist && node -e 'import("@space-df/sdk")' --input-type=module)
+
+if command -v deno &> /dev/null && [ -e ./scripts/build-deno ]
+then
+  ./scripts/build-deno
+fi

package/scripts/utils/check-version.cjs

@@ -0,0 +1,20 @@
+const fs = require('fs');
+const path = require('path');
+
+const main = () => {
+    const pkg = require('../../package.json');
+    const version = pkg['version'];
+    if (!version) throw 'The version property is not set in the package.json file';
+    if (typeof version !== 'string') {
+        throw `Unexpected type for the package.json version field; got ${typeof version}, expected string`;
+    }
+
+    const versionFile = path.resolve(__dirname, '..', '..', 'src', 'version.ts');
+    const contents = fs.readFileSync(versionFile, 'utf8');
+    const output = contents.replace(/(export const VERSION = ')(.*)(')/g, `$1${version}$3`);
+    fs.writeFileSync(versionFile, output);
+};
+
+if (require.main === module) {
+    main();
+}

package/scripts/utils/fix-index-exports.cjs

@@ -0,0 +1,8 @@
+const fs = require('fs');
+const path = require('path');
+
+const indexJs = process.env['DIST_PATH'] ? path.resolve(process.env['DIST_PATH'], 'index.js') : path.resolve(__dirname, '..', '..', 'dist', 'index.js');
+
+let before = fs.readFileSync(indexJs, 'utf8');
+let after = before.replace(/^\s*exports\.default\s*=\s*(\w+)/m, 'exports = module.exports = $1;\nexports.default = $1');
+fs.writeFileSync(indexJs, after, 'utf8');

package/scripts/utils/make-dist-package-json.cjs

@@ -0,0 +1,21 @@
+const pkgJson = require(process.env['PKG_JSON_PATH'] || '../../package.json');
+
+function processExportMap(m) {
+    for (const key in m) {
+        const value = m[key];
+        if (typeof value === 'string') m[key] = value.replace(/^\.\/dist\//, './');
+        else processExportMap(value);
+    }
+}
+processExportMap(pkgJson.exports);
+
+for (const key of ['types', 'main', 'module']) {
+    if (typeof pkgJson[key] === 'string') pkgJson[key] = pkgJson[key].replace(/^(\.\/)?dist\//, './');
+}
+
+delete pkgJson.devDependencies;
+delete pkgJson.scripts.prepack;
+delete pkgJson.scripts.prepublishOnly;
+delete pkgJson.scripts.prepare;
+
+console.log(JSON.stringify(pkgJson, null, 2));

package/scripts/utils/postprocess-files.cjs

@@ -0,0 +1,153 @@
+const fs = require('fs');
+const path = require('path');
+const { parse } = require('@typescript-eslint/parser');
+
+const pkgImportPath = process.env['PKG_IMPORT_PATH'] ?? '@space-df/sdk/';
+
+const distDir = process.env['DIST_PATH'] ? path.resolve(process.env['DIST_PATH']) : path.resolve(__dirname, '..', '..', 'dist');
+const distSrcDir = path.join(distDir, 'src');
+
+/**
+ * Quick and dirty AST traversal
+ */
+function traverse(node, visitor) {
+    if (!node || typeof node.type !== 'string') return;
+    visitor.node?.(node);
+    visitor[node.type]?.(node);
+    for (const key in node) {
+        const value = node[key];
+        if (Array.isArray(value)) {
+            for (const elem of value) traverse(elem, visitor);
+        } else if (value instanceof Object) {
+            traverse(value, visitor);
+        }
+    }
+}
+
+/**
+ * Helper method for replacing arbitrary ranges of text in input code.
+ *
+ * The `replacer` is a function that will be called with a mini-api.  For example:
+ *
+ * replaceRanges('foobar', ({ replace }) => replace([0, 3], 'baz')) // 'bazbar'
+ *
+ * The replaced ranges must not be overlapping.
+ */
+function replaceRanges(code, replacer) {
+    const replacements = [];
+    replacer({ replace: (range, replacement) => replacements.push({ range, replacement }) });
+
+    if (!replacements.length) return code;
+    replacements.sort((a, b) => a.range[0] - b.range[0]);
+    const overlapIndex = replacements.findIndex((r, index) => index > 0 && replacements[index - 1].range[1] > r.range[0]);
+    if (overlapIndex >= 0) {
+        throw new Error(`replacements overlap: ${JSON.stringify(replacements[overlapIndex - 1])} and ${JSON.stringify(replacements[overlapIndex])}`);
+    }
+
+    const parts = [];
+    let end = 0;
+    for (const {
+        range: [from, to],
+        replacement,
+    } of replacements) {
+        if (from > end) parts.push(code.substring(end, from));
+        parts.push(replacement);
+        end = to;
+    }
+    if (end < code.length) parts.push(code.substring(end));
+    return parts.join('');
+}
+
+/**
+ * Like calling .map(), where the iteratee is called on the path in every import or export from statement.
+ * @returns the transformed code
+ */
+function mapModulePaths(code, iteratee) {
+    const ast = parse(code, { range: true });
+    return replaceRanges(code, ({ replace }) =>
+        traverse(ast, {
+            node(node) {
+                switch (node.type) {
+                    case 'ImportDeclaration':
+                    case 'ExportNamedDeclaration':
+                    case 'ExportAllDeclaration':
+                    case 'ImportExpression':
+                        if (node.source) {
+                            const { range, value } = node.source;
+                            const transformed = iteratee(value);
+                            if (transformed !== value) {
+                                replace(range, JSON.stringify(transformed));
+                            }
+                        }
+                }
+            },
+        }),
+    );
+}
+
+async function* walk(dir) {
+    for await (const d of await fs.promises.opendir(dir)) {
+        const entry = path.join(dir, d.name);
+        if (d.isDirectory()) yield* walk(entry);
+        else if (d.isFile()) yield entry;
+    }
+}
+
+async function postprocess() {
+    for await (const file of walk(path.resolve(__dirname, '..', '..', 'dist'))) {
+        if (!/\.([cm]?js|(\.d)?[cm]?ts)$/.test(file)) continue;
+
+        const code = await fs.promises.readFile(file, 'utf8');
+
+        let transformed = mapModulePaths(code, (importPath) => {
+            if (file.startsWith(distSrcDir)) {
+                if (importPath.startsWith(pkgImportPath)) {
+                    // convert self-references in dist/src to relative paths
+                    let relativePath = path.relative(path.dirname(file), path.join(distSrcDir, importPath.substring(pkgImportPath.length)));
+                    if (!relativePath.startsWith('.')) relativePath = `./${relativePath}`;
+                    return relativePath;
+                }
+                return importPath;
+            }
+            if (importPath.startsWith('.')) {
+                // add explicit file extensions to relative imports
+                const { dir, name } = path.parse(importPath);
+                const ext = /\.mjs$/.test(file) ? '.mjs' : '.js';
+                return `${dir}/${name}${ext}`;
+            }
+            return importPath;
+        });
+
+        if (file.startsWith(distSrcDir) && !file.endsWith('_shims/index.d.ts')) {
+            // strip out `unknown extends Foo ? never :` shim guards in dist/src
+            // to prevent errors from appearing in Go To Source
+            transformed = transformed.replace(
+                new RegExp('unknown extends (typeof )?\\S+ \\? \\S+ :\\s*'.replace(/\s+/, '\\s+'), 'gm'),
+                // replace with same number of characters to avoid breaking source maps
+                (match) => ' '.repeat(match.length),
+            );
+        }
+
+        if (file.endsWith('.d.ts')) {
+            // work around bad tsc behavior
+            // if we have `import { type Readable } from 'spacedf-sdk/_shims/index'`,
+            // tsc sometimes replaces `Readable` with `import("stream").Readable` inline
+            // in the output .d.ts
+            transformed = transformed.replace(/import\("stream"\).Readable/g, 'Readable');
+        }
+
+        // strip out lib="dom" and types="node" references; these are needed at build time,
+        // but would pollute the user's TS environment
+        transformed = transformed.replace(
+            /^ *\/\/\/ *<reference +(lib="dom"|types="node").*?\n/gm,
+            // replace with same number of characters to avoid breaking source maps
+            (match) => ' '.repeat(match.length - 1) + '\n',
+        );
+
+        if (transformed !== code) {
+            await fs.promises.writeFile(file, transformed, 'utf8');
+            console.error(`wrote ${path.relative(process.cwd(), file)}`);
+        }
+    }
+}
+postprocess();

package/src/_shims/auto/runtime-deno.ts

@@ -0,0 +1,4 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+export * from '../web-runtime';

package/src/_shims/auto/types-deno.ts

@@ -0,0 +1,4 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+export * from '../web-types';