ag-common 0.0.183 → 0.0.186

package/dist/api/helpers/api.d.ts

@@ -9,6 +9,16 @@ export declare const returnCode: <T>(statusCode: number, body?: T | undefined, e
  * @returns stripped record
  */
 export declare const stripPKs: <T>(record: T, keepPk?: boolean) => T;
+/**
+ * generate dynamo PKs.
+ * PK = all Ls joined with #
+ * PK1 = L1
+ * PK2 = L1#L2
+ * PK3 = L1#L2#L3
+ * ...
+ * @param param0
+ * @returns
+ */
 export declare const generateDynamoPKS: ({ type, L1, L2, L3, L4, L5, L6, additionalPKValues, }: {
     type: string;
     L1: string;

package/dist/api/helpers/api.js

@@ -57,14 +57,26 @@ const stripPKs = (record, keepPk = true) => {
     return rest;
 };
 exports.stripPKs = stripPKs;
+/**
+ * generate dynamo PKs.
+ * PK = all Ls joined with #
+ * PK1 = L1
+ * PK2 = L1#L2
+ * PK3 = L1#L2#L3
+ * ...
+ * @param param0
+ * @returns
+ */
 const generateDynamoPKS = ({ type, L1, L2, L3, L4, L5, L6, additionalPKValues, }) => {
     const c = '#';
     const keys = [L1, L2, L3, L4, L5, L6].filter(array_1.notEmpty);
     const additionalPK = additionalPKValues && (additionalPKValues === null || additionalPKValues === void 0 ? void 0 : additionalPKValues.length) > 0
         ? `#${additionalPKValues.join(c)}`
         : '';
-    return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ PK: keys.join(c) + additionalPK, type,
-        L1 }, (L2 && { L2 })), (L3 && { L3 })), (L4 && { L4 })), (L5 && { L5 })), (L6 && { L6 })), { PK1: L1, PK2: [keys[0], keys[1]].join(c) }), (keys.length >= 3 && {
+    return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ PK: keys.join(c) + additionalPK, type,
+        L1 }, (L2 && { L2 })), (L3 && { L3 })), (L4 && { L4 })), (L5 && { L5 })), (L6 && { L6 })), { PK1: L1 }), (keys.length >= 2 && {
+        PK2: [keys[0], keys[1]].join(c),
+    })), (keys.length >= 3 && {
         PK3: [keys[0], keys[1], keys[2]].join(c),
     })), (keys.length >= 4 && {
         PK4: [keys[0], keys[1], keys[2], keys[3]].join(c),

package/dist/api/helpers/dynamo.js

@@ -212,7 +212,19 @@ const getItemsDynamo = ({ tableName, items, }) => __awaiter(void 0, void 0, void
     }
 });
 exports.getItemsDynamo = getItemsDynamo;
-const queryDynamo = ({ tableName, pkName, pkValue, pkOperator = '=', skName, skValue, skOperator = '=', indexName, count = 1000, startKey: startKeyIn, filterName, filterValue, filterOperator = '=', }) => __awaiter(void 0, void 0, void 0, function* () {
+const queryDynamo = ({ tableName, pkName, pkValue, 
+/**
+ * default =
+ */
+pkOperator = '=', skName, skValue, 
+/**
+ * default =
+ */
+skOperator = '=', indexName, count = 1000, startKey: startKeyIn, filterName, filterValue, 
+/**
+ * default =
+ */
+filterOperator = '=', }) => __awaiter(void 0, void 0, void 0, function* () {
     var _g, _h;
     let startKey = startKeyIn;
     let kce = `#${pkName.toLowerCase()} ${pkOperator} :${pkName.toLowerCase()}`;

package/dist/api/helpers/openApiHelpers.d.ts

@@ -3,17 +3,19 @@ import { Construct } from 'constructs';
 import { aws_certificatemanager as certmgr, aws_route53 as route53 } from 'aws-cdk-lib';
 import { TokenAuthorizer } from 'aws-cdk-lib/aws-apigateway/lib/authorizers/lambda';
 export declare const openApiImpl: (p: {
-    schema: unknown;
     stack: Construct;
+    /**
+     * pass in generated openapi file
+     * eg schema: require('common/openapi.generated').default;
+     */
+    schema: unknown;
     NODE_ENV: string;
-    baseUrl: string;
     endpointsBase: string;
     /**
      * 'default' will be applied to all functions
      */
     lambdaConfig: ILambdaConfigs;
     certificate: certmgr.ICertificate;
-    hostedZone: route53.IHostedZone;
     shortStackName: string;
     /**
      * defaults:
@@ -28,4 +30,10 @@ export declare const openApiImpl: (p: {
      * dictionary of named authorizer functions. these names are to be used in the lambdaConfig param
      */
     authorizers?: Record<string, TokenAuthorizer>;
+    hostedZone: route53.IHostedZone;
+    /**
+     * A record will be created in hosted zone for the apigw on this path. if undefined, record wont be created
+     * eg api.mydomain.com
+     */
+    apiUrl?: string;
 }) => void;

package/dist/api/helpers/openApiHelpers.js

@@ -11,26 +11,28 @@ const getPaths = (schema) => Object.entries(schema.paths).map(([fullPath, verbs]
     pathList: fullPath.split('/').filter((s) => s),
     verbs: Object.keys(verbs),
 }));
-const setUpApiGw = ({ stack, NODE_ENV, baseUrl, certificate, hostedZone, shortStackName, cors = {
+const setUpApiGw = ({ stack, NODE_ENV, certificate, hostedZone, shortStackName, apiUrl, cors = {
     allowOrigins: aws_cdk_lib_1.aws_apigateway.Cors.ALL_ORIGINS,
     allowHeaders: aws_cdk_lib_1.aws_apigateway.Cors.DEFAULT_HEADERS,
 }, }) => {
     const api = new aws_cdk_lib_1.aws_apigateway.RestApi(stack, `${shortStackName}-api-${NODE_ENV}`, {
         defaultCorsPreflightOptions: Object.assign({}, (cors || {})),
     });
-    const dn = new aws_cdk_lib_1.aws_apigateway.DomainName(stack, 'domain', {
-        domainName: `api.${baseUrl}`,
-        certificate,
-        endpointType: aws_cdk_lib_1.aws_apigateway.EndpointType.EDGE,
-        securityPolicy: aws_cdk_lib_1.aws_apigateway.SecurityPolicy.TLS_1_2,
-        mapping: api,
-    });
-    new aws_cdk_lib_1.aws_route53.ARecord(stack, 'ARecord', {
-        comment: '(cdk)',
-        recordName: 'api',
-        zone: hostedZone,
-        target: aws_cdk_lib_1.aws_route53.RecordTarget.fromAlias(new aws_cdk_lib_1.aws_route53_targets.ApiGatewayDomain(dn)),
-    });
+    if (apiUrl) {
+        const dn = new aws_cdk_lib_1.aws_apigateway.DomainName(stack, 'domain', {
+            domainName: apiUrl,
+            certificate,
+            endpointType: aws_cdk_lib_1.aws_apigateway.EndpointType.EDGE,
+            securityPolicy: aws_cdk_lib_1.aws_apigateway.SecurityPolicy.TLS_1_2,
+            mapping: api,
+        });
+        new aws_cdk_lib_1.aws_route53.ARecord(stack, 'ARecord', {
+            comment: '(cdk)',
+            recordName: apiUrl.substring(0, apiUrl.indexOf('.')),
+            zone: hostedZone,
+            target: aws_cdk_lib_1.aws_route53.RecordTarget.fromAlias(new aws_cdk_lib_1.aws_route53_targets.ApiGatewayDomain(dn)),
+        });
+    }
     return api;
 };
 const setupLambda = ({ lambdaConfig, pathV, verb, seenPermissions, authorizers, }) => {
@@ -53,6 +55,16 @@ const setupLambda = ({ lambdaConfig, pathV, verb, seenPermissions, authorizers,
     const policies = [...(def.policies || []), ...((lp === null || lp === void 0 ? void 0 : lp.policies) || [])].filter(array_1.notEmpty);
     const layers = [...(def.layers || []), ...((lp === null || lp === void 0 ? void 0 : lp.layers) || [])].filter(array_1.notEmpty);
     const memory = (lp === null || lp === void 0 ? void 0 : lp.memory) || (def === null || def === void 0 ? void 0 : def.memory) || 128;
+    // null forces undefined, undefined forces 5
+    let reservedConcurrentExecutions = lp === null || lp === void 0 ? void 0 : lp.reservedConcurrentExecutions;
+    if (reservedConcurrentExecutions === undefined) {
+        reservedConcurrentExecutions = def === null || def === void 0 ? void 0 : def.reservedConcurrentExecutions;
+    }
+    if (reservedConcurrentExecutions === undefined) {
+        reservedConcurrentExecutions = 5;
+    }
+    reservedConcurrentExecutions = reservedConcurrentExecutions !== null && reservedConcurrentExecutions !== void 0 ? reservedConcurrentExecutions : undefined;
+    //
     const timeout = aws_cdk_lib_1.Duration.seconds((lp === null || lp === void 0 ? void 0 : lp.timeoutS) || (def === null || def === void 0 ? void 0 : def.timeoutS) || 30);
     let authorizerName = lp === null || lp === void 0 ? void 0 : lp.authorizerName;
     if (authorizerName === undefined) {
@@ -79,6 +91,7 @@ const setupLambda = ({ lambdaConfig, pathV, verb, seenPermissions, authorizers,
         authorizer,
         memory,
         timeout,
+        reservedConcurrentExecutions,
     };
 };
 const addApiPaths = (api, pathList, apiRoots) => {
@@ -133,7 +146,7 @@ const openApiImpl = (p) => {
                 bundling: {
                     externalModules: ['aws-sdk', 'aws-lambda'],
                 },
-                reservedConcurrentExecutions: 5,
+                reservedConcurrentExecutions: lc.reservedConcurrentExecutions,
                 logRetention: aws_cdk_lib_1.aws_logs.RetentionDays.FIVE_DAYS,
                 layers: lc.layers,
             });

package/dist/api/types/index.d.ts

@@ -9,7 +9,7 @@ export interface DYNAMOKEYS {
     L5?: string;
     PK: string;
     PK1: string;
-    PK2: string;
+    PK2?: string;
     PK3?: string;
     PK4?: string;
 }
@@ -37,6 +37,10 @@ export interface ILambdaConfig {
      * lambda memory. defaults to 128
      */
     memory?: number;
+    /**
+     * reserved lambda concurrency. defaults to 5. if null, doesnt apply
+     */
+    reservedConcurrentExecutions?: number | null;
 }
 /**
  * 'default' will be applied to all functions
@@ -46,13 +50,14 @@ export interface ILambdaConfigs {
         default?: ILambdaConfig;
     };
 }
+export declare type TSkOperator = 'BETWEEN' | '<' | '<=' | '=' | '>=' | '>';
 export interface IQueryDynamo {
     pkName: string;
     pkValue: string | number;
     pkOperator?: string;
     skName?: string;
     skValue?: string | number | string[] | number[];
-    skOperator?: string;
+    skOperator?: TSkOperator;
     tableName: string;
     indexName?: string;
     count?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ag-common",
-  "version": "0.0.183",
+  "version": "0.0.186",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "author": "Andrei Gec <@andreigec> (https://gec.dev/)",