@lorion-org/runtime-config-node 1.0.0-beta.1 → 1.0.0-beta.5

package/README.md

@@ -187,7 +187,7 @@ For adapters that resolve schema locations from scope directories, use
 `validateRuntimeConfigScopes(...)` to collect `validated` and `skipped`
 targets before the AJV validation runs.
 
-Runnable example files live in [`examples/`](./examples).
+Runnable example files live in [`snippets/`](./snippets).
 
 ## Local commands
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lorion-org/runtime-config-node",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.5",
   "description": "Node file-system helpers for runtime-config directories and files.",
   "license": "MIT",
   "repository": {
@@ -38,7 +38,6 @@
   },
   "files": [
     "dist",
-    "examples",
     "LICENSE",
     "src/**/*.ts",
     "!src/**/*.spec.ts"
@@ -54,7 +53,7 @@
   },
   "dependencies": {
     "ajv": "^8.17.1",
-    "@lorion-org/runtime-config": "^1.0.0-beta.1"
+    "@lorion-org/runtime-config": "^1.0.0-beta.5"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/examples/env-assignments.ts

@@ -1,21 +0,0 @@
-import {
-  loadRuntimeConfigShellAssignments,
-  writeRuntimeConfigFragment,
-} from '@lorion-org/runtime-config-node';
-
-writeRuntimeConfigFragment('./var', 'checkout', {
-  public: {
-    successPath: '/orders/confirmed',
-  },
-  private: {
-    signingSecret: 'checkout_signing_secret_demo',
-  },
-});
-
-const assignments = loadRuntimeConfigShellAssignments('./var', {
-  prefix: 'APP',
-});
-
-console.log(assignments);
-// APP_PUBLIC_CHECKOUT_SUCCESS_PATH='"/orders/confirmed"'
-// APP_PRIVATE_CHECKOUT_SIGNING_SECRET='"checkout_signing_secret_demo"'

package/examples/load-runtime-config-tree.ts

@@ -1,17 +0,0 @@
-import { projectSectionedRuntimeConfig } from '@lorion-org/runtime-config';
-import { loadRuntimeConfigTree, writeRuntimeConfigFragment } from '@lorion-org/runtime-config-node';
-
-writeRuntimeConfigFragment('./var', 'checkout', {
-  public: {
-    successPath: '/orders/confirmed',
-  },
-});
-
-const fragments = loadRuntimeConfigTree('./var');
-const runtimeConfig = projectSectionedRuntimeConfig(fragments);
-
-console.log(runtimeConfig.public);
-// { checkoutSuccessPath: '/orders/confirmed' }
-
-console.log(runtimeConfig.private);
-// {}

package/examples/query-runtime-config-tree.ts

@@ -1,53 +0,0 @@
-import {
-  getRuntimeConfigScopeView,
-  getRuntimeConfigValue,
-  listRuntimeConfigFragments,
-  projectRuntimeConfigTree,
-  writeRuntimeConfigFragment,
-} from '@lorion-org/runtime-config-node';
-
-writeRuntimeConfigFragment('./var', 'checkout', {
-  public: {
-    successPath: '/orders/confirmed',
-  },
-  private: {
-    signingSecret: 'checkout_signing_secret_demo',
-  },
-  contexts: {
-    'eu-store': {
-      public: {
-        successPath: '/eu-store/orders/confirmed',
-      },
-    },
-  },
-});
-
-const listResult = listRuntimeConfigFragments('./var');
-console.log(listResult.scopes);
-// [{ scopeId: 'checkout', publicKeys: ['successPath'], privateKeys: ['signingSecret'], contextIds: ['eu-store'], ... }]
-
-const projectResult = projectRuntimeConfigTree('./var', {
-  contextOutputKey: '__stores',
-});
-console.log(projectResult.runtimeConfig.public);
-// {
-//   checkoutSuccessPath: '/orders/confirmed',
-//   __stores: {
-//     'eu-store': {
-//       checkoutSuccessPath: '/eu-store/orders/confirmed',
-//     },
-//   },
-// }
-
-const valueResult = getRuntimeConfigValue('./var', 'checkout', 'successPath', {
-  contextId: 'eu-store',
-  contextOutputKey: '__stores',
-});
-console.log(valueResult.value);
-// /eu-store/orders/confirmed
-
-const scopeResult = getRuntimeConfigScopeView('./var', 'checkout', {
-  visibility: 'private',
-});
-console.log(scopeResult.config);
-// { signingSecret: 'checkout_signing_secret_demo' }

package/examples/source-and-scope-files.ts

@@ -1,24 +0,0 @@
-import {
-  readRuntimeConfigScopeJson,
-  resolveRuntimeConfigPublicFilePath,
-  resolveRuntimeConfigSource,
-  writeRuntimeConfigScopeJson,
-} from '@lorion-org/runtime-config-node';
-
-const source = resolveRuntimeConfigSource({
-  defaultVarDir: './var',
-  env: process.env,
-  envKey: 'APP_VAR_DIR',
-});
-
-writeRuntimeConfigScopeJson(source, 'checkout', 'settings.json', {
-  successPath: '/orders/confirmed',
-});
-
-const settings = readRuntimeConfigScopeJson(source, 'checkout', 'settings.json');
-console.log(settings);
-// { successPath: '/orders/confirmed' }
-
-const logoPath = resolveRuntimeConfigPublicFilePath(source, 'checkout/logo.svg');
-console.log(logoPath);
-// /absolute/project/path/var/runtime-config/public/checkout/logo.svg