@uniformdev/cli 19.158.0 → 19.159.1-alpha.9

package/dist/chunk-2TESILZJ.mjs

@@ -0,0 +1,267 @@
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined")
+    return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+
+// ../../node_modules/.pnpm/tsup@8.0.2_@microsoft+api-extractor@7.43.2_postcss@8.4.38_typescript@5.3.3/node_modules/tsup/assets/esm_shims.js
+import { fileURLToPath } from "url";
+import path from "path";
+var getFilename = () => fileURLToPath(import.meta.url);
+var getDirname = () => path.dirname(getFilename());
+var __dirname = /* @__PURE__ */ getDirname();
+
+// src/sync/util.ts
+import { mkdirSync, readFileSync, writeFileSync } from "fs";
+import { dump, load } from "js-yaml";
+import { dirname, extname, isAbsolute, resolve, sep } from "path";
+import { fetch as undiciFetch, ProxyAgent } from "undici";
+function withConfiguration(yargs) {
+  return yargs.option("serialization", {
+    skipValidation: true,
+    hidden: true
+  });
+}
+function withApiOptions(yargs) {
+  return yargs.option("apiKey", {
+    describe: "Uniform API key. Defaults to UNIFORM_CLI_API_KEY or UNIFORM_API_KEY env. Supports dotenv.",
+    default: process.env.UNIFORM_CLI_API_KEY ?? // deprecated
+    process.env.CANVAS_CLI_API_KEY ?? // deprecated
+    process.env.UPM_CLI_API_KEY ?? process.env.UNIFORM_API_KEY,
+    demandOption: true,
+    type: "string"
+  }).option("apiHost", {
+    describe: "Uniform host. Defaults to UNIFORM_CLI_BASE_URL env var or https://uniform.app. Supports dotenv.",
+    default: process.env.UNIFORM_CLI_BASE_URL || "https://uniform.app",
+    demandOption: true,
+    type: "string"
+  }).option("edgeApiHost", {
+    describe: "Uniform edge host. Defaults to UNIFORM_CLI_BASE_EDGE_URL env var or https://uniform.global. Supports dotenv.",
+    default: process.env.UNIFORM_CLI_BASE_EDGE_URL || "https://uniform.global",
+    demandOption: true,
+    type: "string"
+  }).option("proxy", {
+    describe: "HTTPS proxy to use for Uniform API calls. Defaults to HTTPS_PROXY, https_proxy, ALL_PROXY, or all_proxy env vars (in that order). Supports dotenv.",
+    default: process.env.HTTPS_PROXY || process.env.https_proxy || process.env.ALL_PROXY || process.env.all_proxy,
+    type: "string"
+  });
+}
+function nodeFetchProxy(proxy) {
+  if (proxy) {
+    console.log(`\u{1F991} Using proxy ${proxy}`);
+  }
+  const wrappedFetch = (input, init) => {
+    if (proxy) {
+      const wrappedInit = {
+        ...init,
+        dispatcher: new ProxyAgent(proxy)
+      };
+      return undiciFetch(input, wrappedInit);
+    }
+    return undiciFetch(input, init);
+  };
+  return wrappedFetch;
+}
+function withProjectOptions(yargs) {
+  return yargs.option("project", {
+    describe: "Uniform project ID. Defaults to UNIFORM_CLI_PROJECT_ID or UNIFORM_PROJECT_ID env. Supports dotenv.",
+    default: process.env.UNIFORM_CLI_PROJECT_ID ?? // deprecated
+    process.env.CANVAS_CLI_PROJECT_ID ?? // deprecated
+    process.env.UPM_CLI_PROJECT_ID ?? process.env.UNIFORM_PROJECT_ID,
+    demandOption: true,
+    type: "string",
+    alias: ["p"]
+  });
+}
+function withTeamOptions(yargs) {
+  return yargs.option("team", {
+    describe: "Uniform team ID. Defaults to UNIFORM_CLI_TEAM_ID or UNIFORM_TEAM_ID env. Supports dotenv.",
+    default: process.env.UNIFORM_CLI_TEAM_ID ?? process.env.UNIFORM_TEAM_ID,
+    demandOption: true,
+    type: "string",
+    alias: ["p"]
+  });
+}
+function withFormatOptions(yargs) {
+  return yargs.option("format", {
+    alias: ["f"],
+    describe: "Output format",
+    default: "yaml",
+    choices: ["yaml", "json"],
+    type: "string"
+  }).option("filename", {
+    alias: ["o"],
+    describe: "Output filename. If not specified, write to stdout.",
+    type: "string"
+  });
+}
+function withDiffOptions(yargs) {
+  return yargs.option("diff", {
+    describe: "Whether to show diffs in stdout. off = no diffs; update = on for updates; on = updates, creates, deletes. Can be set by UNIFORM_CLI_DIFF_MODE environment variable.",
+    default: process.env.UNIFORM_CLI_DIFF_MODE ?? "off",
+    type: "string",
+    choices: ["off", "update", "on"],
+    alias: ["d"]
+  });
+}
+function isPathAPackageFile(path2) {
+  const extension = extname(path2);
+  return extension === ".yaml" || extension === ".yml" || extension === ".json";
+}
+function emitWithFormat(object, format, filename) {
+  let content;
+  if (filename && !format) {
+    const extension = extname(filename);
+    if (extension === ".yaml" || extension === ".yml") {
+      format = "yaml";
+    } else if (extension === ".json") {
+      format = "json";
+    }
+  } else if (!format) {
+    throw new Error("Format must be specified when no filename is passed");
+  }
+  switch (format) {
+    case "json":
+      content = JSON.stringify(object, null, 2);
+      break;
+    case "yaml":
+      content = dump(object);
+      if ("$schema" in object) {
+        content = `# yaml-language-server: $schema=<${object["$schema"]}>
+${content}`;
+      }
+      break;
+    default:
+      throw new Error(`Unsupported format: ${format}`);
+  }
+  if (filename) {
+    const directory = dirname(filename);
+    mkDirByPathSync(directory);
+    writeFileSync(filename, content, "utf8");
+  } else {
+    console.log(content);
+  }
+}
+function mkDirByPathSync(targetDir, { isRelativeToScript = false } = {}) {
+  const initDir = isAbsolute(targetDir) ? sep : "";
+  const baseDir = isRelativeToScript ? __dirname : ".";
+  return targetDir.split(sep).reduce((parentDir, childDir) => {
+    const curDir = resolve(baseDir, parentDir, childDir);
+    try {
+      mkdirSync(curDir);
+    } catch (err) {
+      if (err.code === "EEXIST") {
+        return curDir;
+      }
+      if (err.code === "ENOENT") {
+        throw new Error(`EACCES: permission denied, mkdir '${parentDir}'`);
+      }
+      const caughtErr = ["EACCES", "EPERM", "EISDIR"].indexOf(err.code) > -1;
+      if (!caughtErr || caughtErr && curDir === resolve(targetDir)) {
+        throw err;
+      }
+    }
+    return curDir;
+  }, initDir);
+}
+function readFileToObject(filename) {
+  const file = readFileSync(filename, "utf8");
+  return load(file, { filename, json: true });
+}
+async function* paginateAsync(fetchPage, options) {
+  const perPage = options.pageSize || 100;
+  let offset = 0;
+  let pageData = [];
+  do {
+    pageData = await fetchPage(offset, perPage);
+    for (const item of pageData) {
+      yield item;
+    }
+    offset += perPage;
+  } while (pageData.length === perPage);
+}
+var defaultSyncConfiguration = {
+  entitiesConfig: {},
+  directory: "uniform-data",
+  allowEmptySource: false,
+  format: "yaml",
+  mode: "mirror"
+};
+var applyDefaultSyncConfiguration = (config) => {
+  const mergedConfig = {
+    serialization: {
+      ...defaultSyncConfiguration,
+      ...config?.serialization ?? {},
+      entitiesConfig: {
+        ...defaultSyncConfiguration.entitiesConfig,
+        ...config?.serialization?.entitiesConfig ?? {}
+      }
+    }
+  };
+  for (const entityType in mergedConfig.serialization.entitiesConfig) {
+    const entityTypeCasted = entityType;
+    const entityConfig = mergedConfig.serialization.entitiesConfig[entityTypeCasted];
+    if (Object.keys(entityConfig).length === 0) {
+      const separator = mergedConfig.serialization.directory[mergedConfig.serialization.directory.length - 1] === "/" ? "" : "/";
+      mergedConfig.serialization.entitiesConfig[entityTypeCasted].directory = isPathAPackageFile(
+        mergedConfig.serialization.directory
+      ) ? mergedConfig.serialization.directory : `${mergedConfig.serialization.directory}${separator}${entityTypeCasted}`;
+    }
+  }
+  return mergedConfig;
+};
+var getEntityOption = ({
+  optionName,
+  config,
+  entityType,
+  operation
+}) => {
+  if (config.entitiesConfig[entityType]?.[operation]?.[optionName]) {
+    return config.entitiesConfig[entityType]?.[operation]?.[optionName];
+  }
+  if (config.entitiesConfig[entityType]?.[optionName]) {
+    return config.entitiesConfig[entityType]?.[optionName];
+  }
+  if (config[optionName]) {
+    return config[optionName];
+  }
+  throw `No ${optionName} option specified for ${entityType} ${operation}`;
+};
+var getDirectoryOrFilename = ({
+  config,
+  entityType,
+  operation,
+  defaultEntityFolderName = entityType
+}) => {
+  if (config.entitiesConfig[entityType]?.[operation]?.directory) {
+    return config.entitiesConfig[entityType]?.[operation]?.directory;
+  }
+  if (config.entitiesConfig[entityType]?.directory) {
+    return config.entitiesConfig[entityType]?.directory;
+  }
+  const isPackage = isPathAPackageFile(config.directory);
+  if (isPackage) {
+    return config.directory;
+  }
+  return `${config.directory}/${defaultEntityFolderName}`;
+};
+
+export {
+  __require,
+  withConfiguration,
+  withApiOptions,
+  nodeFetchProxy,
+  withProjectOptions,
+  withTeamOptions,
+  withFormatOptions,
+  withDiffOptions,
+  isPathAPackageFile,
+  emitWithFormat,
+  readFileToObject,
+  paginateAsync,
+  applyDefaultSyncConfiguration,
+  getEntityOption,
+  getDirectoryOrFilename
+};

package/dist/defaultConfig.d.mts

@@ -0,0 +1,46 @@
+import { C as CLIConfiguration, E as EntityTypes } from './index-CwNHvz9G.mjs';
+
+type UniformConfigAllOptions = {
+    /**
+     * The default config preset to use as a basis.
+     * 'all' - includes all possible serializable entities
+     * 'none' - includes no serializable entities, you must define each one
+     *
+     * NOTE: Uniform may make additive changes to the all preset without being considered a breaking change,
+     * in the event new entity types are added.
+     */
+    preset: 'all';
+    /** Override the default config to customize it. */
+    overrides?: {
+        /**
+         * Override the config for specific entities.
+         * Keys defined here will set the config, enabling or overriding the default config.
+         */
+        entitiesConfig?: CLIConfiguration['serialization']['entitiesConfig'];
+        serializationConfig?: Omit<CLIConfiguration['serialization'], 'entitiesConfig'>;
+    };
+    /**
+     * Explicitly disable specific entity types.
+     * Useful to create an 'all entities, except' configuration.
+     * Note: this is applied last, so it will also disable any entity types enabled by overrides.
+     */
+    disableEntities?: EntityTypes[];
+};
+type UniformConfigNoneOptions = {
+    /**
+     * The default config preset to use as a basis.
+     * 'all' - includes all possible serializable entities
+     * 'none' - includes no serializable entities, you must define each one
+     */
+    preset: 'none';
+    /**
+     * Provide the configuration to use here.
+     */
+    config: CLIConfiguration;
+};
+/**
+ * Creates a Uniform CLI configuration.
+ */
+declare function uniformConfig(options: UniformConfigAllOptions | UniformConfigNoneOptions): CLIConfiguration;
+
+export { CLIConfiguration, type UniformConfigAllOptions, type UniformConfigNoneOptions, uniformConfig };

package/dist/defaultConfig.mjs

@@ -0,0 +1,51 @@
+import "./chunk-2TESILZJ.mjs";
+
+// src/sync/allSerializableEntitiesConfig.ts
+var allSerializableEntitiesConfig = {
+  dataType: {},
+  locale: {},
+  category: {},
+  redirect: {},
+  component: {},
+  projectMapDefinition: {},
+  projectMapNode: {},
+  contentType: {},
+  composition: { publish: true },
+  entry: { publish: true },
+  entryPattern: { publish: true },
+  componentPattern: { publish: true },
+  asset: {},
+  workflow: {},
+  aggregate: {},
+  enrichment: {},
+  prompt: {},
+  quirk: {},
+  signal: {},
+  test: {}
+};
+
+// src/defaultConfig.ts
+function uniformConfig(options) {
+  if (options.preset === "none") {
+    return options.config;
+  }
+  const { overrides, preset, disableEntities } = options;
+  const config = {
+    serialization: {
+      ...overrides?.serializationConfig,
+      entitiesConfig: {
+        ...preset === "all" ? allSerializableEntitiesConfig : {},
+        ...overrides?.entitiesConfig
+      }
+    }
+  };
+  if (disableEntities) {
+    for (const entityType of disableEntities) {
+      delete config?.serialization?.entitiesConfig?.[entityType];
+    }
+  }
+  return config;
+}
+export {
+  uniformConfig
+};

package/dist/index-CwNHvz9G.d.mts

@@ -0,0 +1,48 @@
+type CLICompositionState = 'preview' | 'published' | number;
+type StateArgs = {
+    state: CLICompositionState;
+};
+
+type SyncMode = 'mirror' | 'createOrUpdate' | 'create';
+type EntityTypes = 'aggregate' | 'asset' | 'category' | 'workflow' | 'component' | 'composition' | 'contentType' | 'dataType' | 'enrichment' | 'entry' | 'entryPattern' | 'locale' | 'componentPattern' | 'projectMapDefinition' | 'projectMapNode' | 'prompt' | 'quirk' | 'redirect' | 'signal' | 'test';
+type SyncFileFormat = 'yaml' | 'json';
+type EntityConfiguration = {
+    mode?: SyncMode;
+    directory?: string;
+    format?: SyncFileFormat;
+    disabled?: true;
+};
+type EntityWithStateConfiguration = EntityConfiguration & Partial<StateArgs>;
+type PublishableEntitiesConfiguration = EntityWithStateConfiguration & {
+    publish?: boolean;
+};
+type SerializationEntitiesConfiguration = Record<EntityTypes | 'pattern', {
+    pull?: EntityConfiguration;
+    push?: EntityConfiguration;
+} & EntityConfiguration> & {
+    composition?: PublishableEntitiesConfiguration;
+    /**
+     * @deprecated will be removed in a future major release. Use the "componentPattern" property instead.
+     * It's an alias, so you can safely rename this property.
+     */
+    pattern?: PublishableEntitiesConfiguration;
+    componentPattern?: PublishableEntitiesConfiguration;
+    entry?: PublishableEntitiesConfiguration;
+    entryPattern?: PublishableEntitiesConfiguration;
+};
+type SerializationConfiguration = {
+    entitiesConfig: Partial<SerializationEntitiesConfiguration>;
+    directory: string;
+    mode: SyncMode;
+    allowEmptySource: boolean;
+    format: SyncFileFormat;
+};
+type RecursivePartial<T> = {
+    [P in keyof T]?: RecursivePartial<T[P]>;
+};
+type UserDefinedSerializationConfiguration = RecursivePartial<SerializationConfiguration>;
+type CLIConfiguration = {
+    serialization: UserDefinedSerializationConfiguration;
+};
+
+export type { CLIConfiguration as C, EntityTypes as E };

package/dist/index.d.mts

@@ -1,48 +1,2 @@
 #!/usr/bin/env node
-type CLICompositionState = 'preview' | 'published' | number;
-type StateArgs = {
-    state: CLICompositionState;
-};
-
-type SyncMode = 'mirror' | 'createOrUpdate' | 'create';
-type EntityTypes = 'aggregate' | 'asset' | 'category' | 'workflow' | 'component' | 'composition' | 'contentType' | 'dataType' | 'enrichment' | 'entry' | 'entryPattern' | 'locale' | 'componentPattern' | 'projectMapDefinition' | 'projectMapNode' | 'prompt' | 'quirk' | 'redirect' | 'signal' | 'test';
-type SyncFileFormat = 'yaml' | 'json';
-type EntityConfiguration = {
-    mode?: SyncMode;
-    directory?: string;
-    format?: SyncFileFormat;
-    disabled?: true;
-};
-type EntityWithStateConfiguration = EntityConfiguration & Partial<StateArgs>;
-type PublishableEntitiesConfiguration = EntityWithStateConfiguration & {
-    publish?: boolean;
-};
-type SerializationConfiguration = {
-    entitiesConfig: Partial<Record<EntityTypes | 'pattern', {
-        pull?: EntityConfiguration;
-        push?: EntityConfiguration;
-    } & EntityConfiguration> & {
-        composition?: PublishableEntitiesConfiguration;
-        /**
-         * @deprecated will be removed in a future major release. Use the "componentPattern" property instead.
-         * It's an alias, so you can safely rename this property.
-         */
-        pattern?: PublishableEntitiesConfiguration;
-        componentPattern?: PublishableEntitiesConfiguration;
-        entry?: PublishableEntitiesConfiguration;
-        entryPattern?: PublishableEntitiesConfiguration;
-    }>;
-    directory: string;
-    mode: SyncMode;
-    allowEmptySource: boolean;
-    format: SyncFileFormat;
-};
-type RecursivePartial<T> = {
-    [P in keyof T]?: RecursivePartial<T[P]>;
-};
-type UserDefinedSerializationConfiguration = RecursivePartial<SerializationConfiguration>;
-type CLIConfiguration = {
-    serialization: UserDefinedSerializationConfiguration;
-};
-
-export type { CLIConfiguration };
+export { C as CLIConfiguration } from './index-CwNHvz9G.mjs';