@takeshape/util 10.16.0 → 10.18.0

package/dist/index.d.ts

@@ -2,4 +2,5 @@ export * from './common';
 export * from './encryption';
 export * from './gzip';
 export * from './search-params';
+export * from './naming';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AAEzB,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC;AACvB,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AAEzB,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC;AACvB,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC"}

package/dist/index.js

@@ -46,4 +46,15 @@ Object.keys(_searchParams).forEach(function (key) {
       return _searchParams[key];
     }
   });
+});
+var _naming = require("./naming");
+Object.keys(_naming).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _naming[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _naming[key];
+    }
+  });
 });

package/dist/naming.d.ts

@@ -0,0 +1,21 @@
+export type NamingConfig = {
+    withVariant: boolean;
+    withRegion: boolean;
+    separator: string;
+    case?: 'kebabCase' | 'camelCase';
+};
+export type NamingParams = {
+    appName: string;
+    stage: {
+        env: string;
+        variant?: string;
+    };
+    region?: string;
+};
+export declare function prefixName(config: NamingConfig, params: NamingParams, name: string): string;
+export declare function dynamoTableName(params: NamingParams, name: string): string;
+export declare const sharedResourceName: (params: NamingParams, name: string) => string;
+export declare function sharedBucketName(params: NamingParams, name: string): string;
+export declare const sharedTopicName: (params: NamingParams, name: string) => string;
+export declare function keyName(params: NamingParams, name: string): string;
+//# sourceMappingURL=naming.d.ts.map

package/dist/naming.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"naming.d.ts","sourceRoot":"","sources":["../../src/naming.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,WAAW,GAAG,WAAW,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE;QACL,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,wBAAgB,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,UAgClF;AAED,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAE1E;AAED,eAAO,MAAM,kBAAkB,gDAK7B,CAAC;AAEH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAE3E;AAED,eAAO,MAAM,eAAe,gDAAqB,CAAC;AAElD,wBAAgB,OAAO,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAElE"}

package/dist/naming.js

@@ -0,0 +1,76 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.dynamoTableName = dynamoTableName;
+exports.keyName = keyName;
+exports.prefixName = prefixName;
+exports.sharedBucketName = sharedBucketName;
+exports.sharedTopicName = exports.sharedResourceName = void 0;
+var _camelCase = _interopRequireDefault(require("lodash/camelCase"));
+var _kebabCase = _interopRequireDefault(require("lodash/kebabCase"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function prefixName(config, params, name) {
+  const {
+    withVariant,
+    withRegion,
+    separator
+  } = config;
+  const {
+    appName,
+    stage: {
+      env,
+      variant
+    },
+    region
+  } = params;
+  const parts = [appName, env];
+  if (withVariant && env !== 'prod' && variant) {
+    parts.push(variant);
+  }
+  if (withRegion) {
+    if (!region) {
+      throw new Error('Cannot provide a region prefix without a region in context');
+    }
+    parts.push(region);
+  }
+  if (name === '*') {
+    parts.push(name);
+  } else if (config.case === 'kebabCase') {
+    parts.push((0, _kebabCase.default)(name));
+  } else if (config.case === 'camelCase') {
+    parts.push((0, _camelCase.default)(name));
+  } else {
+    parts.push(name);
+  }
+  return parts.join(separator);
+}
+function dynamoTableName(params, name) {
+  return prefixName({
+    withVariant: true,
+    withRegion: false,
+    separator: '--'
+  }, params, name);
+}
+const sharedResourceName = exports.sharedResourceName = prefixName.bind(null, {
+  withVariant: false,
+  withRegion: false,
+  separator: '--',
+  case: 'kebabCase'
+});
+function sharedBucketName(params, name) {
+  return prefixName({
+    withVariant: false,
+    withRegion: true,
+    separator: '--'
+  }, params, name);
+}
+const sharedTopicName = exports.sharedTopicName = sharedResourceName;
+function keyName(params, name) {
+  return prefixName({
+    withVariant: true,
+    withRegion: false,
+    separator: '--'
+  }, params, name);
+}

package/es/index.js

@@ -2,4 +2,5 @@ export * from './common';
 // Node-only exports
 export * from './encryption';
 export * from './gzip';
-export * from './search-params';
+export * from './search-params';
+export * from './naming';

package/es/naming.js

@@ -0,0 +1,65 @@
+import camelCase from 'lodash/camelCase';
+import kebabCase from 'lodash/kebabCase';
+export function prefixName(config, params, name) {
+  const {
+    withVariant,
+    withRegion,
+    separator
+  } = config;
+  const {
+    appName,
+    stage: {
+      env,
+      variant
+    },
+    region
+  } = params;
+  const parts = [appName, env];
+  if (withVariant && env !== 'prod' && variant) {
+    parts.push(variant);
+  }
+  if (withRegion) {
+    if (!region) {
+      throw new Error('Cannot provide a region prefix without a region in context');
+    }
+    parts.push(region);
+  }
+  if (name === '*') {
+    parts.push(name);
+  } else if (config.case === 'kebabCase') {
+    parts.push(kebabCase(name));
+  } else if (config.case === 'camelCase') {
+    parts.push(camelCase(name));
+  } else {
+    parts.push(name);
+  }
+  return parts.join(separator);
+}
+export function dynamoTableName(params, name) {
+  return prefixName({
+    withVariant: true,
+    withRegion: false,
+    separator: '--'
+  }, params, name);
+}
+export const sharedResourceName = prefixName.bind(null, {
+  withVariant: false,
+  withRegion: false,
+  separator: '--',
+  case: 'kebabCase'
+});
+export function sharedBucketName(params, name) {
+  return prefixName({
+    withVariant: false,
+    withRegion: true,
+    separator: '--'
+  }, params, name);
+}
+export const sharedTopicName = sharedResourceName;
+export function keyName(params, name) {
+  return prefixName({
+    withVariant: true,
+    withRegion: false,
+    separator: '--'
+  }, params, name);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@takeshape/util",
-  "version": "10.16.0",
+  "version": "10.18.0",
   "description": "Shared utilities",
   "homepage": "https://www.takeshape.io",
   "repository": {
@@ -33,7 +33,7 @@
     "shortid": "^2.2.16",
     "tiny-invariant": "^1.2.0",
     "url-parse": "^1.5.3",
-    "@takeshape/routing": "10.16.0"
+    "@takeshape/routing": "10.18.0"
   },
   "devDependencies": {
     "@types/classnames": "^2.2.9",
@@ -46,7 +46,7 @@
     "@types/prismjs": "^1.16.2",
     "@types/shortid": "^0.0.29",
     "stripe": "13.8.0",
-    "@takeshape/typescript-jest-junit-reporter": "10.16.0"
+    "@takeshape/typescript-jest-junit-reporter": "10.18.0"
   },
   "engines": {
     "node": ">=18"