@imtbl/sdk 0.31.0 → 0.31.2-alpha

package/rollup.config.js

@@ -0,0 +1,158 @@
+import typescript from '@rollup/plugin-typescript';
+import { nodeResolve } from '@rollup/plugin-node-resolve';
+import { readFileSync } from 'fs';
+import commonJs from '@rollup/plugin-commonjs';
+import json from '@rollup/plugin-json';
+import dts from 'rollup-plugin-dts';
+import replace from '@rollup/plugin-replace';
+import pkg from './package.json' assert { type: 'json' };
+import moduleReleases from './module-release.json' assert { type: 'json' };
+import terser from '@rollup/plugin-terser';
+import nodePolyfills from 'rollup-plugin-polyfill-node';
+
+
+// RELEASE_TYPE environment variable is set by the CI/CD pipeline
+const releaseType = process.env.RELEASE_TYPE || 'alpha';
+
+const packages = JSON.parse(
+  readFileSync('./workspace-packages.json', { encoding: 'utf8' })
+);
+
+const getPackages = () => packages.map((pkg) => pkg.name);
+
+// Get relevant files to bundle
+const getFilesToBuild = () => {
+  // Always build the index file
+  const files = ['index'];
+
+  const moduleFiles = Object.keys(moduleReleases.modules);
+  if (releaseType === 'alpha') {
+    return [...files, ...moduleFiles];
+  }
+
+  const returnModules = moduleFiles.filter(
+    (file) => moduleReleases.modules[file] === 'prod'
+  );
+  return [...files, ...returnModules];
+};
+
+const getFileBuild = (inputFilename) => [
+  {
+    input: `./src/${inputFilename}.ts`,
+    output: {
+      dir: './',
+      format: 'es',
+    },
+    plugins: [
+      nodeResolve({
+        resolveOnly: getPackages(),
+      }),
+      commonJs(),
+      json(),
+      typescript({
+        declaration: true,
+        declarationDir: './dist/types',
+      }),
+      replace({
+        exclude: 'node_modules/**',
+        preventAssignment: true,
+        __SDK_VERSION__: pkg.version,
+      }),
+      terser(),
+    ],
+  },
+  {
+    input: `./dist/types/${inputFilename}.d.ts`,
+    output: {
+      file: `./${inputFilename}.d.ts`,
+      format: 'es',
+    },
+    plugins: [
+      dts({
+        respectExternal: true,
+      }),
+    ],
+  },
+];
+
+const buildBundles = () => {
+  const modules = [];
+  const filesToBuild = getFilesToBuild();
+  for (const file of filesToBuild) {
+    modules.push(...getFileBuild(file));
+  }
+  return modules;
+};
+
+export default [
+  // Main build entry
+  {
+    input: 'src/index.ts',
+    output: {
+      file: './index.cjs',
+      format: 'cjs',
+    },
+    plugins: [
+      nodeResolve({
+        resolveOnly: getPackages(),
+      }),
+      json(),
+      commonJs(),
+      typescript({
+        declaration: true,
+        declarationDir: './dist/types/cjs',
+      }),
+      replace({
+        exclude: 'node_modules/**',
+        preventAssignment: true,
+        __SDK_VERSION__: pkg.version,
+      }),
+      terser(),
+    ],
+  },
+  {
+    input: `./dist/types/cjs/index.d.ts`,
+    output: {
+      file: `./index.d.cts`
+    },
+    plugins: [
+      dts({
+        respectExternal: true,
+      }),
+    ],
+  },  
+  // Browser Bundle
+  {
+    input: 'src/index.ts',
+    output: {
+      file: 'dist/index.browser.js',
+      format: 'umd',
+      sourcemap: true,
+      name: 'immutable',
+    },
+    plugins: [
+      nodeResolve({
+        jsnext: true,
+        main: true,
+        browser: true,
+      }),
+      nodePolyfills(),
+      commonJs(),
+      typescript(),
+      json(),
+      replace({
+        // Can't exclude node_modules here because some dependencies use process.env.NODE_ENV
+        // this breaks in browsers
+        preventAssignment: true,
+        __SDK_VERSION__: pkg.version,
+        
+        // This breaks in a dex dependency, so manually replacing it.
+        'process.env.NODE_ENV': '"production"'
+      }),
+      terser(),
+    ],
+  },
+
+  // Export ES Modules
+  ...buildBundles(),
+];

package/scripts/copyBrowserBundles.js

@@ -0,0 +1,62 @@
+import fs from 'fs';
+import * as glob from 'glob';
+import path from 'path';
+import pkg from '../package.json' assert { type: 'json' };
+
+const dirname = path.dirname(new URL(import.meta.url).pathname);
+
+const SDK_VERSION = '__SDK_VERSION__';
+
+const getFiles = () => {
+  // Read the JSON file
+  const moduleReleaseData = fs.readFileSync(
+    path.join(dirname, '..', 'module-release.json'),
+  );
+  const fileList = JSON.parse(moduleReleaseData.toString()).fileCopy;
+  return fileList;
+};
+
+function findAndReplace(data, find, replace) {
+  if (!data.includes(find)) return data;
+  return data.replace(new RegExp(find, 'g'), replace);
+}
+
+const main = () => {
+  const fileList = getFiles();
+
+  const releaseType = process.env.RELEASE_TYPE || 'alpha';
+
+  // Loop through each item in the list
+  fileList.forEach((item) => {
+    // Check if this item should be copied based on its "stage" property and RELEASE_TYPE environment variable
+    if (
+      releaseType === 'alpha'
+      || (releaseType !== 'alpha' && item.stage === 'prod')
+    ) {
+      // Find all matching files using glob pattern matching
+      const srcPath = path.join(dirname, '..', item.src);
+      const files = glob.sync(srcPath);
+
+      // Copy each file to its destination location
+      files.forEach((sourceFile) => {
+        const destPath = path.join(dirname, '..', item.dest);
+
+        const directoryPath = path.dirname(destPath);
+        if (!fs.existsSync(directoryPath)) {
+          fs.mkdirSync(directoryPath, { recursive: true });
+        }
+
+        let data = fs.readFileSync(sourceFile, 'utf-8');
+
+        data = findAndReplace(data, SDK_VERSION, pkg.version);
+        // Add more findAndReplace if and when needed
+        // data = findAndReplace(data, <find>, <replace>);
+
+        fs.writeFileSync(destPath, data);
+      });
+    }
+  });
+};
+
+// Execute
+main();

package/scripts/generate-package-list.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -e
+
+yarn workspaces list --json | sed -e ' $ ! s/}/},/' | sed '$ s/$/]/' | sed '1 s/^/[/' > workspace-packages.json

package/scripts/generateIndex.js

@@ -0,0 +1,44 @@
+import fs from 'fs';
+import path from 'path';
+
+const dirname = path.dirname(new URL(import.meta.url).pathname);
+
+// Read the JSON file
+const fileData = fs.readFileSync(
+  path.join(dirname, '..', 'module-release.json'),
+);
+const moduleData = JSON.parse(fileData);
+
+// Get the release type from the environment variable or default to 'alpha'
+const releaseType = process.env.RELEASE_TYPE || 'alpha';
+
+// Generate the index.ts file contents based on the release type
+let indexFileContent = '';
+Object.keys(moduleData.modules).forEach((moduleName) => {
+  const moduleReleaseType = moduleData.modules[moduleName];
+
+  if (
+    releaseType === 'alpha'
+    || (releaseType !== 'alpha' && moduleReleaseType === 'prod')
+  ) {
+    // Split underscores and capitalize each word from the second
+    const moduleNameCapitalized = moduleName.split('_')
+      .map((part, index) => {
+        if (index === 0) {
+          return part;
+        }
+        return part.charAt(0).toUpperCase() + part.slice(1);
+      })
+      .join('');
+
+    const modulePath = `./${moduleName}`;
+    const exportStatement = `export * as ${moduleNameCapitalized} from '${modulePath}';\n`;
+    indexFileContent += exportStatement;
+  }
+});
+
+// Write the index.ts file
+fs.writeFileSync(
+  path.join(process.cwd(), 'src', 'index.ts'),
+  indexFileContent,
+);

package/scripts/updateDependencies.js

@@ -0,0 +1,137 @@
+//@ts-check
+import { getPluginConfiguration } from '@yarnpkg/cli';
+import { Configuration, Project } from '@yarnpkg/core';
+import semver from 'semver';
+import fs from 'fs';
+import path from 'path';
+
+const __dirname = path.resolve();
+const SDK_PACKAGE = '@imtbl/sdk';
+
+const getWorkspacePackages = () => {
+  const workspacePackages = JSON.parse(
+    fs.readFileSync(path.resolve(__dirname, 'workspace-packages.json'), {
+      encoding: 'utf8',
+    })
+  ).map((pkg) => pkg.name);
+  return workspacePackages;
+};
+const workspacePackages = getWorkspacePackages();
+
+// Update the map with the dependency if it doesn't exist, or if the
+// version is greater than the existing version
+const updateVersion = (map, dependency, version) => {
+  // Don't add any workspace packages as a dependency
+  if (workspacePackages.includes(dependency)) return;
+
+  const existingVersion = map.get(dependency);
+
+  if (
+    !existingVersion ||
+    semver.gt(parseVersion(version), parseVersion(existingVersion))
+  ) {
+    map.set(dependency, version);
+  }
+};
+
+// Recusively go through a workspace, and return it's dependencies
+// and peer dependencies
+const collectDependenciesRecusively = async (sdkWorkspace) => {
+  const dependenciesMap = new Map();
+  const peerDependenciesMap = new Map();
+
+  // Recursively go through a workspace and update the dependencies
+  const processWorkspace = (workspace) => {
+    const manifest = workspace.manifest;
+    const { dependencies, peerDependencies, devDependencies } = manifest;
+
+    // Dev dependencies, only check if they're workspace packages
+    // And then process them
+    devDependencies.forEach((dep) => {
+      const depWorkspace = workspace.project.tryWorkspaceByIdent(dep);
+      if (depWorkspace) {
+        processWorkspace(depWorkspace);
+      }
+    });
+
+    // If sdkpackage, exit early
+    if (manifest.raw.name === SDK_PACKAGE) return;
+
+    // UpdateVersion for dependencies
+    dependencies.forEach((dep) => {
+      updateVersion(
+        dependenciesMap,
+        packageName(dep.scope, dep.name),
+        dep.range
+      );
+
+      const depWorkspace = workspace.project.tryWorkspaceByIdent(dep);
+      if (depWorkspace) {
+        processWorkspace(depWorkspace);
+      }
+    });
+
+    // Same for peerDependencies, but don't recurse
+    peerDependencies.forEach((dep) =>
+      updateVersion(
+        peerDependenciesMap,
+        packageName(dep.scope, dep.name),
+        dep.range
+      )
+    );
+  };
+
+  // Start the recursive process
+  processWorkspace(sdkWorkspace);
+
+  return {
+    dependencies: Object.fromEntries(dependenciesMap.entries()),
+    peerDependencies: Object.fromEntries(peerDependenciesMap.entries()),
+  };
+};
+
+// Takes a scope and a package name and returns a scoped package name
+const packageName = (scope, name) => {
+  return scope ? `@${scope}/${name}` : name;
+};
+
+// Remove ranges to parse just version
+const parseVersion = (version) => {
+  return version.replace(/^[^\d]*/, '');
+};
+
+// Update package.json with the dependencies and peerDependencies
+const main = async () => {
+  const cwd = process.cwd();
+  const pluginConfiguration = getPluginConfiguration();
+  const configuration = await Configuration.find(cwd, pluginConfiguration);
+  const { project } = await Project.find(configuration, cwd);
+
+  const targetWorkspace = project.workspaces.find(
+    (workspace) => workspace.manifest.raw.name === SDK_PACKAGE
+  );
+
+  if (!targetWorkspace) {
+    throw Error(`${SDK_PACKAGE} package not found`);
+  }
+
+  const { dependencies, peerDependencies } =
+    await collectDependenciesRecusively(targetWorkspace);
+
+  const packageJson = JSON.parse(
+    fs.readFileSync(path.resolve(__dirname, 'package.json'), 'utf8')
+  );
+
+  packageJson.dependencies = dependencies;
+  // Only add peerDependencies if there are any
+  if (Object.values(peerDependencies).length > 0) {
+    packageJson.peerDependencies = peerDependencies;
+  }
+
+  fs.writeFileSync(
+    path.resolve(__dirname, 'package.json'),
+    JSON.stringify(packageJson, null, 2)
+  );
+};
+
+main();

package/scripts/updateExports.js

@@ -0,0 +1,62 @@
+/* eslint-disable */
+import fs from 'fs';
+import path from 'path';
+
+const __dirname = path.dirname(new URL(import.meta.url).pathname);
+
+// Read the module-release.json file
+const moduleReleaseData = fs.readFileSync(
+  path.join(__dirname, '..', 'module-release.json')
+);
+const moduleData = JSON.parse(moduleReleaseData);
+
+// Get the release type from the environment variable or default to 'alpha'
+const releaseType = process.env.RELEASE_TYPE || 'alpha';
+
+// Update the package.json exports based on the release type
+const packageJsonPath = path.join(__dirname, '..', 'package.json');
+const packageJsonData = fs.readFileSync(packageJsonPath, 'utf8');
+const packageJson = JSON.parse(packageJsonData);
+
+const exports = {
+  './package.json': './package.json',
+  '.': {
+    imports: {
+      types: './index.d.ts',
+      default: './index.js',
+    },
+    require: {
+      types: './index.d.cts',
+      default: './index.cjs',
+    }
+  },
+};
+
+for (const moduleName in moduleData.modules) {
+  // if (moduleName === 'config') {
+  //   continue; // Skip config module as it's explicitly defined for '.'
+  // }
+
+  const moduleReleaseType = moduleData.modules[moduleName];
+
+  if (
+    releaseType === 'alpha' ||
+    (releaseType !== 'alpha' && moduleReleaseType === 'prod')
+  ) {
+    const moduleExport = `./${moduleName}`;
+    const modulePath = `./${moduleName}.js`;
+    const typesPath = `./${moduleName}.d.ts`;
+
+    exports[moduleExport] = {
+      types: typesPath,
+      import: modulePath,
+    };
+  }
+}
+
+packageJson.exports = exports;
+
+// Write the updated package.json file
+fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
+
+console.log('Package.json exports updated successfully!');

package/src/blockchain_data.ts

@@ -0,0 +1 @@
+export * from '@imtbl/blockchain-data';

package/src/checkout_sdk.ts

@@ -0,0 +1 @@
+export * from '@imtbl/checkout-sdk';

package/src/checkout_widgets.ts

@@ -0,0 +1 @@
+export * from '@imtbl/checkout-widgets';

package/src/config.ts

@@ -0,0 +1 @@
+export * from '@imtbl/config';

package/src/immutablex_client.ts

@@ -0,0 +1 @@
+export * from '@imtbl/immutablex-client';

package/src/index.ts

@@ -0,0 +1,7 @@
+export * as config from './config';
+export * as blockchainData from './blockchain_data';
+export * as immutablexClient from './immutablex_client';
+export * as passport from './passport';
+export * as orderbook from './orderbook';
+export * as provider from './provider';
+export * as checkoutSdk from './checkout_sdk';

package/src/orderbook.ts

@@ -0,0 +1 @@
+export * from '@imtbl/orderbook';

package/src/passport.ts

@@ -0,0 +1 @@
+export * from '@imtbl/passport';

package/src/provider.ts

@@ -0,0 +1 @@
+export * from '@imtbl/provider';

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "baseUrl": "./src",
+    "outDir": "./dist",
+    "rootDirs": ["src"],
+    "target": "es2022",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noEmit": true,
+    "allowJs": false,
+    "removeComments": false,
+    "strict": true,
+    "forceConsistentCasingInFileNames": false,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "declaration": false,
+    "resolveJsonModule": true,
+    "skipLibCheck": true
+  },
+  "include": ["src"],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "src/modules/provider/sample-app",
+    "src/modules/checkout"
+  ]
+}

package/typedoc.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+}

package/workspace-packages.json

@@ -0,0 +1,31 @@
+[{"location":".","name":"ts-immutable-sdk"},
+{"location":"packages/blockchain-data/sample-app","name":"blockchain-data-sample-app"},
+{"location":"packages/blockchain-data/sdk","name":"@imtbl/blockchain-data"},
+{"location":"packages/checkout/sdk","name":"@imtbl/checkout-sdk"},
+{"location":"packages/checkout/sdk-sample-app","name":"@imtbl/checkout-sdk-sample-app"},
+{"location":"packages/checkout/widgets-lib","name":"@imtbl/checkout-widgets"},
+{"location":"packages/checkout/widgets-sample-app","name":"@imtbl/checkout-widgets-sample-app"},
+{"location":"packages/config","name":"@imtbl/config"},
+{"location":"packages/economy/playground","name":"@imtbl/economy-playground"},
+{"location":"packages/economy/sdk","name":"@imtbl/economy"},
+{"location":"packages/economy/services","name":"@imtbl/economy-services"},
+{"location":"packages/game-bridge","name":"@imtbl/game-bridge"},
+{"location":"packages/immutablex_client","name":"@imtbl/immutablex-client"},
+{"location":"packages/internal/bridge/bridge-sample-app","name":"bridge-sample-app"},
+{"location":"packages/internal/bridge/sdk","name":"@imtbl/bridge-sdk"},
+{"location":"packages/internal/cryptofiat","name":"@imtbl/cryptofiat"},
+{"location":"packages/internal/dex/sdk","name":"@imtbl/dex-sdk"},
+{"location":"packages/internal/dex/sdk-sample-app","name":"sdk-sample-app"},
+{"location":"packages/internal/economy-building-blocks/playground","name":"@imtbl/economy-building-blocks-playground"},
+{"location":"packages/internal/factory/factory-sample-app","name":"factory-sample-app"},
+{"location":"packages/internal/factory/sdk","name":"@imtbl/factory-sdk"},
+{"location":"packages/internal/generated-clients","name":"@imtbl/generated-clients"},
+{"location":"packages/internal/guardian","name":"@imtbl/guardian"},
+{"location":"packages/internal/toolkit","name":"@imtbl/toolkit"},
+{"location":"packages/internal/version-check","name":"@imtbl/version-check"},
+{"location":"packages/orderbook","name":"@imtbl/orderbook"},
+{"location":"packages/passport/sdk","name":"@imtbl/passport"},
+{"location":"packages/passport/sdk-sample-app","name":"@imtbl/passport-sdk-sample-app"},
+{"location":"packages/provider","name":"@imtbl/provider"},
+{"location":"packages/provider/src/sample-app","name":"sample-app"},
+{"location":"sdk","name":"@imtbl/sdk"}]