@linzjs/cdk-tags 1.1.0 → 1.3.0

package/README.md

@@ -2,22 +2,40 @@
 
 CDK construct to apply common tags to constructs
 
-
 ## Usage
 
 To apply the common set of tags for a s3 bucket:
 
 ```typescript
-import {applyTags, SecurityClassification} from '@linzjs/cdk-tags';
+import { applyTags, SecurityClassification } from '@linzjs/cdk-tags';
 
-const bucket = new Bucket(this, 'ImageryArchive')
+const bucket = new Bucket(this, 'ImageryArchive');
 
 applyTags(bucket, {
   application: 'basemaps',
   group: 'li',
   classification: SecurityClassification.Unclassified,
   data: { isMaster: true, isPublic: true, role: TagDataRole.Archive },
+  criticality: 'low',
 });
 ```
 
+To apply the common set of tags for multiple constructs:
+
+```typescript
+import { applyTags, SecurityClassification, TagsBase } from '@linzjs/cdk-tags';
+
+const commonTags: TagsBase = {
+  application: 'basemaps',
+  group: 'li',
+  classification: SecurityClassification.Unclassified,
+  data: { isMaster: true, isPublic: true, role: TagDataRole.Archive },
+  criticality: 'low',
+};
+
+const bucket1 = new Bucket(this, 'ImageryArchive');
+const bucket2 = new Bucket(this, 'AnotherImageryArchive');
 
+applyTags(bucket1, commonTags);
+applyTags(bucket2, commonTags);
+```

package/build/src/index.d.ts

@@ -1,3 +1,4 @@
-export { getGitBuildInfo } from './build.js';
-export { SecurityClassification } from './security.js';
-export { applyTags, applyTagsData } from './tags.js';
+export { getGitBuildInfo } from './build';
+export { SecurityClassification } from './security';
+export type { TagsBase } from './tags';
+export { applyTags, applyTagsData } from './tags';

package/build/src/index.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.applyTagsData = exports.applyTags = exports.SecurityClassification = exports.getGitBuildInfo = void 0;
-var build_js_1 = require("./build.js");
-Object.defineProperty(exports, "getGitBuildInfo", { enumerable: true, get: function () { return build_js_1.getGitBuildInfo; } });
-var security_js_1 = require("./security.js");
-Object.defineProperty(exports, "SecurityClassification", { enumerable: true, get: function () { return security_js_1.SecurityClassification; } });
-var tags_js_1 = require("./tags.js");
-Object.defineProperty(exports, "applyTags", { enumerable: true, get: function () { return tags_js_1.applyTags; } });
-Object.defineProperty(exports, "applyTagsData", { enumerable: true, get: function () { return tags_js_1.applyTagsData; } });
+var build_1 = require("./build");
+Object.defineProperty(exports, "getGitBuildInfo", { enumerable: true, get: function () { return build_1.getGitBuildInfo; } });
+var security_1 = require("./security");
+Object.defineProperty(exports, "SecurityClassification", { enumerable: true, get: function () { return security_1.SecurityClassification; } });
+var tags_1 = require("./tags");
+Object.defineProperty(exports, "applyTags", { enumerable: true, get: function () { return tags_1.applyTags; } });
+Object.defineProperty(exports, "applyTagsData", { enumerable: true, get: function () { return tags_1.applyTagsData; } });
 //# sourceMappingURL=index.js.map

package/build/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,uCAA6C;AAApC,2GAAA,eAAe,OAAA;AACxB,6CAAuD;AAA9C,qHAAA,sBAAsB,OAAA;AAC/B,qCAAqD;AAA5C,oGAAA,SAAS,OAAA;AAAE,wGAAA,aAAa,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,iCAA0C;AAAjC,wGAAA,eAAe,OAAA;AACxB,uCAAoD;AAA3C,kHAAA,sBAAsB,OAAA;AAE/B,+BAAkD;AAAzC,iGAAA,SAAS,OAAA;AAAE,qGAAA,aAAa,OAAA"}

package/build/src/tags.d.ts

@@ -42,6 +42,20 @@ export interface TagsBase {
      * @see https://www.digital.govt.nz/standards-and-guidance/governance/managing-online-channels/security-and-privacy-for-websites/foundations/classify-information/
      */
     classification: SecurityClassification;
+    /**
+     * Criticality of the resources
+     */
+    criticality: 'critical' | 'high' | 'medium' | 'low';
+    /**
+     * THe responder team listed in OpsGenie.
+     * @see https://toitutewhenua.app.opsgenie.com/teams/list
+     */
+    responderTeam?: string;
+    /**
+     * skip collection of git info, commit, version etc
+     * @default false
+     */
+    skipGitInfo?: boolean;
     /** Data classification tags */
     data?: TagsData;
 }

package/build/src/tags.js

@@ -17,28 +17,33 @@ function applyTags(construct, ctx) {
     if (ctx.data?.isPublic && ctx.classification !== security_js_1.SecurityClassification.Unclassified) {
         throw new Error('Only unclassified constructs can be made public');
     }
-    const buildInfo = (0, build_js_1.getGitBuildInfo)();
+    const buildInfo = ctx.skipGitInfo ? undefined : (0, build_js_1.getGitBuildInfo)();
     // applications tags
-    tag(construct, 'linz:app:name', ctx.application);
-    tag(construct, 'linz:app:version', buildInfo.version);
-    tag(construct, 'linz:environment', ctx.environment);
+    tag(construct, 'linz.app.name', ctx.application);
+    if (buildInfo)
+        tag(construct, 'linz.app.version', buildInfo.version);
+    tag(construct, 'linz.environment', ctx.environment);
     // Ownership tags
-    tag(construct, 'linz:group', ctx.group);
+    tag(construct, 'linz.group', ctx.group);
+    tag(construct, 'linz.responder.team', ctx.responderTeam ?? 'NotSet');
+    tag(construct, 'linz.app.criticality', ctx.criticality);
     // Git Tags
-    tag(construct, 'linz:git:hash', buildInfo.hash);
-    tag(construct, 'linz:git:repository', process.env['GITHUB_REPOSITORY'] ?? ctx.repository);
+    if (buildInfo)
+        tag(construct, 'linz.git.hash', buildInfo.hash);
+    tag(construct, 'linz.git.repository', process.env['GITHUB_REPOSITORY'] ?? ctx.repository);
     // Github actions build information
-    tag(construct, 'linz:build:id', buildInfo.buildId);
+    if (buildInfo)
+        tag(construct, 'linz.build.id', buildInfo.buildId);
     // Security
-    tag(construct, 'linz:security:classification', ctx.classification);
+    tag(construct, 'linz.security.classification', ctx.classification);
     if (ctx.data)
         applyTagsData(construct, ctx.data);
 }
 exports.applyTags = applyTags;
 function applyTagsData(construct, tags) {
-    tag(construct, 'linz:data:role', tags.role);
-    tag(construct, 'linz:data:is-master', String(tags.isMaster ?? false));
-    tag(construct, 'linz:data:is-public', String(tags.isPublic ?? false));
+    tag(construct, 'linz.data.role', tags.role);
+    tag(construct, 'linz.data.is-master', String(tags.isMaster ?? false));
+    tag(construct, 'linz.data.is-public', String(tags.isPublic ?? false));
 }
 exports.applyTagsData = applyTagsData;
 //# sourceMappingURL=tags.js.map

package/build/src/tags.js.map

@@ -1 +1 @@
-{"version":3,"file":"tags.js","sourceRoot":"","sources":["../../src/tags.ts"],"names":[],"mappings":";;;AAAA,6CAAmC;AAGnC,yCAA6C;AAE7C,+CAAuD;AAoDvD,6EAA6E;AAC7E,SAAS,GAAG,CAAC,SAAqB,EAAE,GAAW,EAAE,KAAgC;IAC/E,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO;IAC1B,IAAI,KAAK,KAAK,EAAE;QAAE,OAAO;IAEzB,kBAAI,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACrC,CAAC;AAED,SAAgB,SAAS,CAAC,SAAqB,EAAE,GAAa;IAC5D,iCAAiC;IACjC,IAAI,GAAG,CAAC,IAAI,EAAE,QAAQ,IAAI,GAAG,CAAC,cAAc,KAAK,oCAAsB,CAAC,YAAY,EAAE,CAAC;QACrF,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IACD,MAAM,SAAS,GAAG,IAAA,0BAAe,GAAE,CAAC;IAEpC,oBAAoB;IACpB,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;IACjD,GAAG,CAAC,SAAS,EAAE,kBAAkB,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IACtD,GAAG,CAAC,SAAS,EAAE,kBAAkB,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;IAEpD,iBAAiB;IACjB,GAAG,CAAC,SAAS,EAAE,YAAY,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;IAExC,WAAW;IACX,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IAChD,GAAG,CAAC,SAAS,EAAE,qBAAqB,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC;IAE1F,mCAAmC;IACnC,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAEnD,WAAW;IACX,GAAG,CAAC,SAAS,EAAE,8BAA8B,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC;IACnE,IAAI,GAAG,CAAC,IAAI;QAAE,aAAa,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;AACnD,CAAC;AAzBD,8BAyBC;AAED,SAAgB,aAAa,CAAC,SAAqB,EAAE,IAAc;IACjE,GAAG,CAAC,SAAS,EAAE,gBAAgB,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,GAAG,CAAC,SAAS,EAAE,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC;IACtE,GAAG,CAAC,SAAS,EAAE,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC;AACxE,CAAC;AAJD,sCAIC"}
+{"version":3,"file":"tags.js","sourceRoot":"","sources":["../../src/tags.ts"],"names":[],"mappings":";;;AAAA,6CAAmC;AAGnC,yCAA6C;AAE7C,+CAAuD;AAoEvD,6EAA6E;AAC7E,SAAS,GAAG,CAAC,SAAqB,EAAE,GAAW,EAAE,KAAgC;IAC/E,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO;IAC1B,IAAI,KAAK,KAAK,EAAE;QAAE,OAAO;IAEzB,kBAAI,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACrC,CAAC;AAED,SAAgB,SAAS,CAAC,SAAqB,EAAE,GAAa;IAC5D,iCAAiC;IACjC,IAAI,GAAG,CAAC,IAAI,EAAE,QAAQ,IAAI,GAAG,CAAC,cAAc,KAAK,oCAAsB,CAAC,YAAY,EAAE,CAAC;QACrF,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,SAAS,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,0BAAe,GAAE,CAAC;IAElE,oBAAoB;IACpB,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;IACjD,IAAI,SAAS;QAAE,GAAG,CAAC,SAAS,EAAE,kBAAkB,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IACrE,GAAG,CAAC,SAAS,EAAE,kBAAkB,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;IAEpD,iBAAiB;IACjB,GAAG,CAAC,SAAS,EAAE,YAAY,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;IACxC,GAAG,CAAC,SAAS,EAAE,qBAAqB,EAAE,GAAG,CAAC,aAAa,IAAI,QAAQ,CAAC,CAAC;IACrE,GAAG,CAAC,SAAS,EAAE,sBAAsB,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;IAExD,WAAW;IACX,IAAI,SAAS;QAAE,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/D,GAAG,CAAC,SAAS,EAAE,qBAAqB,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC;IAE1F,mCAAmC;IACnC,IAAI,SAAS;QAAE,GAAG,CAAC,SAAS,EAAE,eAAe,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAElE,WAAW;IACX,GAAG,CAAC,SAAS,EAAE,8BAA8B,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC;IACnE,IAAI,GAAG,CAAC,IAAI;QAAE,aAAa,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;AACnD,CAAC;AA5BD,8BA4BC;AAED,SAAgB,aAAa,CAAC,SAAqB,EAAE,IAAc;IACjE,GAAG,CAAC,SAAS,EAAE,gBAAgB,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,GAAG,CAAC,SAAS,EAAE,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC;IACtE,GAAG,CAAC,SAAS,EAAE,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC;AACxE,CAAC;AAJD,sCAIC"}

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@linzjs/cdk-tags",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
   "files": [
-    "build"
+    "build/src"
   ],
   "author": {
     "name": "Land Information New Zealand",
@@ -23,7 +23,7 @@
     "access": "public"
   },
   "repository": {
-    "url": "git://github.com/linz/cdk-tag.git",
+    "url": "git://github.com/linz/cdk-tags.git",
     "type": "git"
   },
   "peerDependencies": {
@@ -32,6 +32,6 @@
   },
   "devDependencies": {
     "@linzjs/style": "^5.2.0",
-    "@types/node": "^20.11.30"
+    "@types/node": "^20.12.8"
   }
 }