@platforma-sdk/block-tools 2.6.44 → 2.6.45

package/src/cmd/mark-stable.ts

@@ -1,53 +1,50 @@
-import { Command, Flags } from '@oclif/core';
-import { BlockRegistryV2, loadPackDescriptionRaw } from '../v2';
-import path from 'node:path';
-import {
-  overrideDescriptionVersion,
-  StableChannel,
-} from '@milaboratories/pl-model-middle-layer';
-import { storageByUrl } from '../io';
-import { OclifLoggerAdapter } from '@milaboratories/ts-helpers-oclif';
+import { Command, Flags } from "@oclif/core";
+import { BlockRegistryV2, loadPackDescriptionRaw } from "../v2";
+import path from "node:path";
+import { overrideDescriptionVersion, StableChannel } from "@milaboratories/pl-model-middle-layer";
+import { storageByUrl } from "../io";
+import { OclifLoggerAdapter } from "@milaboratories/ts-helpers-oclif";
 
 export default class MarkStable extends Command {
-  static description = 'Mark target block stable';
+  static description = "Mark target block stable";
 
   static flags = {
-    'modulePath': Flags.string({
-      char: 'i',
-      summary: 'input module path',
-      helpValue: '<path>',
-      default: '.',
+    modulePath: Flags.string({
+      char: "i",
+      summary: "input module path",
+      helpValue: "<path>",
+      default: ".",
     }),
 
-    'channel': Flags.string({
-      char: 'c',
+    channel: Flags.string({
+      char: "c",
       hidden: true,
-      summary: 'custom channel',
-      helpValue: '<channel name>',
+      summary: "custom channel",
+      helpValue: "<channel name>",
       default: StableChannel,
     }),
 
-    'version-override': Flags.file({
-      char: 'v',
-      summary: 'override package version',
+    "version-override": Flags.file({
+      char: "v",
+      summary: "override package version",
     }),
 
-    'registry': Flags.string({
-      char: 'r',
-      summary: 'full address of the registry',
-      helpValue: '<address>',
-      env: 'PL_REGISTRY',
+    registry: Flags.string({
+      char: "r",
+      summary: "full address of the registry",
+      helpValue: "<address>",
+      env: "PL_REGISTRY",
       required: true,
     }),
 
-    'refresh': Flags.boolean({
-      summary: 'refresh repository after adding the package',
+    refresh: Flags.boolean({
+      summary: "refresh repository after adding the package",
       default: true,
       allowNo: true,
-      env: 'PL_REGISTRY_REFRESH',
+      env: "PL_REGISTRY_REFRESH",
     }),
 
-    'unmark': Flags.boolean({
+    unmark: Flags.boolean({
       summary:
         'reverses meaning of this command, flag can be used to remove "stable" flag from the package',
       default: false,
@@ -57,8 +54,8 @@ export default class MarkStable extends Command {
   public async run(): Promise<void> {
     const { flags } = await this.parse(MarkStable);
     let description = await loadPackDescriptionRaw(path.resolve(flags.modulePath));
-    if (flags['version-override'])
-      description = overrideDescriptionVersion(description, flags['version-override']);
+    if (flags["version-override"])
+      description = overrideDescriptionVersion(description, flags["version-override"]);
     const storage = storageByUrl(flags.registry);
     const registry = new BlockRegistryV2(storage, new OclifLoggerAdapter(this));
 

package/src/cmd/pack.ts

@@ -1,26 +1,26 @@
-import { Command, Flags } from '@oclif/core';
-import { loadPackDescription } from '../v2/source_package';
-import path from 'node:path';
-import { buildBlockPackDist } from '../v2/build_dist';
+import { Command, Flags } from "@oclif/core";
+import { loadPackDescription } from "../v2/source_package";
+import path from "node:path";
+import { buildBlockPackDist } from "../v2/build_dist";
 
 export default class PackBlock extends Command {
-  static description
-    = 'Builds block pack and outputs a block pack manifest consolidating all '
-    + 'references assets into a single folder';
+  static description =
+    "Builds block pack and outputs a block pack manifest consolidating all " +
+    "references assets into a single folder";
 
   static flags = {
     modulePath: Flags.string({
-      char: 'i',
-      summary: 'input module path',
-      helpValue: '<path>',
-      default: '.',
+      char: "i",
+      summary: "input module path",
+      helpValue: "<path>",
+      default: ".",
     }),
 
     destinationPath: Flags.string({
-      char: 'o',
-      summary: 'output folder',
-      helpValue: '<path>',
-      default: './block-pack',
+      char: "o",
+      summary: "output folder",
+      helpValue: "<path>",
+      default: "./block-pack",
     }),
   };
 

package/src/cmd/publish.ts

@@ -1,11 +1,15 @@
-import { Command, Flags } from '@oclif/core';
-import fs from 'node:fs';
-import { OclifLoggerAdapter } from '@milaboratories/ts-helpers-oclif';
-import { ManifestFileName } from '../v2/registry/schema_public';
-import { BlockPackManifest, overrideManifestVersion, StableChannel } from '@milaboratories/pl-model-middle-layer';
-import { storageByUrl } from '../io/storage';
-import { BlockRegistryV2 } from '../v2/registry/registry';
-import path from 'node:path';
+import { Command, Flags } from "@oclif/core";
+import fs from "node:fs";
+import { OclifLoggerAdapter } from "@milaboratories/ts-helpers-oclif";
+import { ManifestFileName } from "../v2/registry/schema_public";
+import {
+  BlockPackManifest,
+  overrideManifestVersion,
+  StableChannel,
+} from "@milaboratories/pl-model-middle-layer";
+import { storageByUrl } from "../io/storage";
+import { BlockRegistryV2 } from "../v2/registry/registry";
+import path from "node:path";
 
 function simpleDeepMerge<T extends Record<string, unknown>>(
   target: Record<string, unknown>,
@@ -14,9 +18,12 @@ function simpleDeepMerge<T extends Record<string, unknown>>(
   const result = { ...target };
 
   for (const key in source) {
-    if (source[key] && typeof source[key] === 'object' && !Array.isArray(source[key])) {
-      if (result[key] && typeof result[key] === 'object' && !Array.isArray(result[key])) {
-        result[key] = simpleDeepMerge(result[key] as Record<string, unknown>, source[key] as Record<string, unknown>);
+    if (source[key] && typeof source[key] === "object" && !Array.isArray(source[key])) {
+      if (result[key] && typeof result[key] === "object" && !Array.isArray(result[key])) {
+        result[key] = simpleDeepMerge(
+          result[key] as Record<string, unknown>,
+          source[key] as Record<string, unknown>,
+        );
       } else {
         result[key] = source[key];
       }
@@ -29,41 +36,41 @@ function simpleDeepMerge<T extends Record<string, unknown>>(
 }
 
 export default class Publish extends Command {
-  static description
-    = 'Publishes the block package and refreshes the registry (for v2 block-pack schema)';
+  static description =
+    "Publishes the block package and refreshes the registry (for v2 block-pack schema)";
 
   static flags = {
-    'registry': Flags.string({
-      char: 'r',
-      summary: 'full address of the registry',
-      helpValue: '<address>',
-      env: 'PL_REGISTRY',
+    registry: Flags.string({
+      char: "r",
+      summary: "full address of the registry",
+      helpValue: "<address>",
+      env: "PL_REGISTRY",
       required: true,
     }),
 
-    'manifest': Flags.file({
-      char: 'm',
-      summary: 'manifest file path',
+    manifest: Flags.file({
+      char: "m",
+      summary: "manifest file path",
       exists: true,
       default: `./block-pack/${ManifestFileName}`,
     }),
 
-    'version-override': Flags.file({
-      char: 'v',
-      summary: 'override package version',
+    "version-override": Flags.file({
+      char: "v",
+      summary: "override package version",
     }),
 
-    'refresh': Flags.boolean({
-      summary: 'refresh repository after adding the package',
+    refresh: Flags.boolean({
+      summary: "refresh repository after adding the package",
       default: true,
       allowNo: true,
-      env: 'PL_REGISTRY_REFRESH',
+      env: "PL_REGISTRY_REFRESH",
     }),
 
-    'unstable': Flags.boolean({
-      summary: 'do not add the published package to stable channel',
+    unstable: Flags.boolean({
+      summary: "do not add the published package to stable channel",
       default: false,
-      env: 'PL_PUBLISH_UNSTABLE',
+      env: "PL_PUBLISH_UNSTABLE",
     }),
   };
 
@@ -71,16 +78,21 @@ export default class Publish extends Command {
     const { flags } = await this.parse(Publish);
 
     const manifestPath = path.resolve(flags.manifest);
-    const rawManifest = JSON.parse(await fs.promises.readFile(manifestPath, { encoding: 'utf-8' })) as Record<string, unknown>;
+    const rawManifest = JSON.parse(
+      await fs.promises.readFile(manifestPath, { encoding: "utf-8" }),
+    ) as Record<string, unknown>;
     let manifest = BlockPackManifest.parse(rawManifest);
     // To keep extra fields from the manifest and keep coerced fields
-    manifest = simpleDeepMerge(rawManifest, manifest as BlockPackManifest & Record<string, unknown>);
+    manifest = simpleDeepMerge(
+      rawManifest,
+      manifest as BlockPackManifest & Record<string, unknown>,
+    );
     const manifestRoot = path.dirname(manifestPath);
 
     this.log(`Manifest root = ${manifestRoot}`);
 
-    if (flags['version-override'])
-      manifest = overrideManifestVersion(manifest, flags['version-override']);
+    if (flags["version-override"])
+      manifest = overrideManifestVersion(manifest, flags["version-override"]);
 
     const storage = storageByUrl(flags.registry);
     const registry = new BlockRegistryV2(storage, new OclifLoggerAdapter(this));

package/src/cmd/refresh-registry.ts

@@ -1,27 +1,27 @@
-import { Command, Flags } from '@oclif/core';
-import { BlockRegistryV2 } from '../v2';
-import { storageByUrl } from '../io';
-import { OclifLoggerAdapter } from '@milaboratories/ts-helpers-oclif';
+import { Command, Flags } from "@oclif/core";
+import { BlockRegistryV2 } from "../v2";
+import { storageByUrl } from "../io";
+import { OclifLoggerAdapter } from "@milaboratories/ts-helpers-oclif";
 
 export default class RefreshRegistry extends Command {
-  static description = 'Refresh overview files based on published but not proecessed artefacts';
+  static description = "Refresh overview files based on published but not proecessed artefacts";
 
   static flags = {
     registry: Flags.string({
-      char: 'r',
-      summary: 'full address of the registry',
-      helpValue: '<address>',
-      env: 'PL_REGISTRY',
+      char: "r",
+      summary: "full address of the registry",
+      helpValue: "<address>",
+      env: "PL_REGISTRY",
       required: true,
     }),
 
     mode: Flags.string({
-      char: 'm',
+      char: "m",
       summary: 'refresh mode (allowed valiues: "force", "normal", "dry-run")',
-      helpValue: '<mode>',
-      options: ['force', 'normal', 'dry-run'],
-      env: 'PL_REGISTRY_REFRESH_DRY_RUN',
-      default: 'normal',
+      helpValue: "<mode>",
+      options: ["force", "normal", "dry-run"],
+      env: "PL_REGISTRY_REFRESH_DRY_RUN",
+      default: "normal",
     }),
   };
 
@@ -29,6 +29,6 @@ export default class RefreshRegistry extends Command {
     const { flags } = await this.parse(RefreshRegistry);
     const storage = storageByUrl(flags.registry);
     const registry = new BlockRegistryV2(storage, new OclifLoggerAdapter(this));
-    await registry.updateIfNeeded(flags.mode as 'force' | 'normal' | 'dry-run');
+    await registry.updateIfNeeded(flags.mode as "force" | "normal" | "dry-run");
   }
 }

package/src/cmd/restore-overview-from-snapshot.ts

@@ -1,29 +1,29 @@
-import { Command, Flags } from '@oclif/core';
-import { BlockRegistryV2 } from '../v2/registry/registry';
-import { storageByUrl } from '../io/storage';
-import { OclifLoggerAdapter } from '@milaboratories/ts-helpers-oclif';
+import { Command, Flags } from "@oclif/core";
+import { BlockRegistryV2 } from "../v2/registry/registry";
+import { storageByUrl } from "../io/storage";
+import { OclifLoggerAdapter } from "@milaboratories/ts-helpers-oclif";
 
 export default class RestoreOverviewFromSnapshot extends Command {
-  static description = 'Restore global overview from a snapshot';
+  static description = "Restore global overview from a snapshot";
 
   static flags = {
-    'registry': Flags.string({
-      char: 'r',
-      summary: 'full address of the registry',
-      helpValue: '<address>',
-      env: 'PL_REGISTRY',
+    registry: Flags.string({
+      char: "r",
+      summary: "full address of the registry",
+      helpValue: "<address>",
+      env: "PL_REGISTRY",
       required: true,
     }),
 
-    'snapshot': Flags.string({
-      char: 's',
-      summary: 'snapshot timestamp ID to restore from',
-      helpValue: '<timestamp>',
+    snapshot: Flags.string({
+      char: "s",
+      summary: "snapshot timestamp ID to restore from",
+      helpValue: "<timestamp>",
       required: true,
     }),
 
-    'skip-confirmation': Flags.boolean({
-      summary: 'skip confirmation prompt (use with caution)',
+    "skip-confirmation": Flags.boolean({
+      summary: "skip confirmation prompt (use with caution)",
       default: false,
     }),
   };
@@ -38,14 +38,16 @@ export default class RestoreOverviewFromSnapshot extends Command {
     const targetSnapshot = snapshots.find((s) => s.timestamp === flags.snapshot);
 
     if (!targetSnapshot) {
-      this.error(`Snapshot '${flags.snapshot}' not found. Available snapshots:\n${
-        snapshots.map((s) => `  - ${s.timestamp}`).join('\n') || '  (none)'
-      }`);
+      this.error(
+        `Snapshot '${flags.snapshot}' not found. Available snapshots:\n${
+          snapshots.map((s) => `  - ${s.timestamp}`).join("\n") || "  (none)"
+        }`,
+      );
     }
 
     // Confirmation prompt (unless skipped)
-    if (!flags['skip-confirmation']) {
-      const readline = await import('node:readline');
+    if (!flags["skip-confirmation"]) {
+      const readline = await import("node:readline");
       const rl = readline.createInterface({
         input: process.stdin,
         output: process.stdout,
@@ -53,16 +55,16 @@ export default class RestoreOverviewFromSnapshot extends Command {
 
       const answer = await new Promise<string>((resolve) => {
         rl.question(
-          `⚠️  This will overwrite the current global overview with snapshot '${flags.snapshot}'.\n`
-          + `Are you sure you want to continue? (y/N): `,
+          `⚠️  This will overwrite the current global overview with snapshot '${flags.snapshot}'.\n` +
+            `Are you sure you want to continue? (y/N): `,
           resolve,
         );
       });
 
       rl.close();
 
-      if (answer.toLowerCase() !== 'y' && answer.toLowerCase() !== 'yes') {
-        this.log('Restore cancelled.');
+      if (answer.toLowerCase() !== "y" && answer.toLowerCase() !== "yes") {
+        this.log("Restore cancelled.");
         return;
       }
     }

package/src/cmd/update-deps.ts

@@ -1,20 +1,20 @@
-import { Command } from '@oclif/core';
-import { execFileSync } from 'node:child_process';
-import { createRequire } from 'node:module';
+import { Command } from "@oclif/core";
+import { execFileSync } from "node:child_process";
+import { createRequire } from "node:module";
 
 export default class UpdateDeps extends Command {
-  static override description
-    = 'Updates @platforma-sdk and @milaboratories packages in pnpm-workspace.yaml catalog to their latest versions from npm registry.';
+  static override description =
+    "Updates @platforma-sdk and @milaboratories packages in pnpm-workspace.yaml catalog to their latest versions from npm registry.";
 
-  static override examples = ['<%= config.bin %> <%= command.id %>'];
+  static override examples = ["<%= config.bin %> <%= command.id %>"];
 
   // eslint-disable-next-line @typescript-eslint/require-await -- oclif requires async but implementation is sync
   public async run(): Promise<void> {
     const require = createRequire(import.meta.url);
-    const updaterPath = require.resolve('@platforma-sdk/blocks-deps-updater/scripts/updater.js');
+    const updaterPath = require.resolve("@platforma-sdk/blocks-deps-updater/scripts/updater.js");
 
     execFileSync(process.execPath, [updaterPath], {
-      stdio: 'inherit',
+      stdio: "inherit",
       cwd: process.cwd(),
     });
   }

package/src/cmd/upload-package-v1.ts

@@ -1,62 +1,62 @@
-import { Command, Flags } from '@oclif/core';
-import { getConfig } from '../registry_v1/config';
-import { targetFile } from '../registry_v1/flags';
-import fs from 'node:fs';
-import YAML from 'yaml';
-import { PlRegPackageConfigDataShard } from '../registry_v1/config_schema';
-import { OclifLoggerAdapter } from '@milaboratories/ts-helpers-oclif';
+import { Command, Flags } from "@oclif/core";
+import { getConfig } from "../registry_v1/config";
+import { targetFile } from "../registry_v1/flags";
+import fs from "node:fs";
+import YAML from "yaml";
+import { PlRegPackageConfigDataShard } from "../registry_v1/config_schema";
+import { OclifLoggerAdapter } from "@milaboratories/ts-helpers-oclif";
 
 type BasicConfigField = keyof PlRegPackageConfigDataShard &
-  ('registry' | 'organization' | 'package' | 'version');
-const BasicConfigFields: BasicConfigField[] = ['registry', 'organization', 'package', 'version'];
+  ("registry" | "organization" | "package" | "version");
+const BasicConfigFields: BasicConfigField[] = ["registry", "organization", "package", "version"];
 
 export default class UploadPackageV1 extends Command {
-  static description = 'Uploads V1 package and refreshes the registry';
+  static description = "Uploads V1 package and refreshes the registry";
 
   static flags = {
     registry: Flags.string({
-      char: 'r',
-      summary: 'full address of the registry or alias from .pl.reg',
-      helpValue: '<address|alias>',
-      env: 'PL_REGISTRY',
+      char: "r",
+      summary: "full address of the registry or alias from .pl.reg",
+      helpValue: "<address|alias>",
+      env: "PL_REGISTRY",
     }),
 
     organization: Flags.string({
-      char: 'o',
-      summary: 'target organisation',
-      env: 'PL_PACKAGE_ORGANIZATION',
+      char: "o",
+      summary: "target organisation",
+      env: "PL_PACKAGE_ORGANIZATION",
     }),
 
     package: Flags.string({
-      char: 'p',
-      summary: 'target package',
-      env: 'PL_PACKAGE_NAME',
+      char: "p",
+      summary: "target package",
+      env: "PL_PACKAGE_NAME",
     }),
 
     version: Flags.string({
-      char: 'v',
-      summary: 'target version',
-      env: 'PL_PACKAGE_VERSION',
+      char: "v",
+      summary: "target version",
+      env: "PL_PACKAGE_VERSION",
     }),
 
     meta: Flags.file({
-      char: 'm',
-      summary: 'json file containing meta information to associate with tha package',
+      char: "m",
+      summary: "json file containing meta information to associate with tha package",
       exists: true,
     }),
 
     file: targetFile({
-      char: 'f',
-      summary: 'package files',
+      char: "f",
+      summary: "package files",
       multiple: true,
       default: [],
     }),
 
     refresh: Flags.boolean({
-      summary: 'refresh repository after adding the package',
+      summary: "refresh repository after adding the package",
       default: true,
       allowNo: true,
-      env: 'PL_REGISTRY_REFRESH',
+      env: "PL_REGISTRY_REFRESH",
     }),
   };
 
@@ -67,13 +67,13 @@ export default class UploadPackageV1 extends Command {
     for (const field of BasicConfigFields) if (flags[field]) configFromFlags[field] = flags[field];
 
     if (flags.meta) {
-      if (flags.meta.endsWith('.json'))
+      if (flags.meta.endsWith(".json"))
         configFromFlags.meta = JSON.parse(
-          await fs.promises.readFile(flags.meta, { encoding: 'utf-8' }),
+          await fs.promises.readFile(flags.meta, { encoding: "utf-8" }),
         ) as Record<string, unknown>;
-      else if (flags.meta.endsWith('.yaml'))
+      else if (flags.meta.endsWith(".yaml"))
         configFromFlags.meta = YAML.parse(
-          await fs.promises.readFile(flags.meta, { encoding: 'utf-8' }),
+          await fs.promises.readFile(flags.meta, { encoding: "utf-8" }),
         ) as Record<string, unknown>;
     }
 

package/src/common_types.ts

@@ -1,3 +1,3 @@
-import { z } from 'zod';
+import { z } from "zod";
 
 export const PlRegAddress = z.string().regex(/^(?:s3:|file:)/);

package/src/io/folder_reader.test.ts

@@ -1,21 +1,21 @@
-import { expect, test } from 'vitest';
-import { folderReaderByUrl } from './folder_reader';
+import { expect, test } from "vitest";
+import { folderReaderByUrl } from "./folder_reader";
 
-test('test fs reader', async () => {
-  const reader = folderReaderByUrl('file:.');
-  const content = await reader.getContentReader()('package.json');
+test("test fs reader", async () => {
+  const reader = folderReaderByUrl("file:.");
+  const content = await reader.getContentReader()("package.json");
   expect(content).toBeDefined();
   expect(content.length).toBeGreaterThan(10);
 });
 
-test('test url reader with slash', async () => {
-  const reader = folderReaderByUrl('https://cdn.milaboratory.com/');
-  const content = await reader.getContentReader()('ping');
-  expect(content?.toString('utf8')).toStrictEqual('pong');
+test("test url reader with slash", async () => {
+  const reader = folderReaderByUrl("https://cdn.milaboratory.com/");
+  const content = await reader.getContentReader()("ping");
+  expect(content?.toString("utf8")).toStrictEqual("pong");
 });
 
-test('test url reader without slash', async () => {
-  const reader = folderReaderByUrl('https://cdn.milaboratory.com');
-  const content = await reader.getContentReader()('ping');
-  expect(content?.toString('utf8')).toStrictEqual('pong');
+test("test url reader without slash", async () => {
+  const reader = folderReaderByUrl("https://cdn.milaboratory.com");
+  const content = await reader.getContentReader()("ping");
+  expect(content?.toString("utf8")).toStrictEqual("pong");
 });