@jfvilas/kwirth-common 0.2.1 → 0.2.3

package/dist/AccessKey.d.ts

@@ -0,0 +1,19 @@
+declare class AccessKey {
+    id: string;
+    type: string;
+    resource: string;
+}
+declare function accessKeyCreate(type: string, resource: string): AccessKey;
+declare function accessKeyBuild(id: string, type: string, resource: string): AccessKey;
+declare function accessKeySerialize(accessKey: AccessKey): string;
+declare function accessKeyDeserialize(key: string): AccessKey;
+declare function parseResource(key: string): ResourceIdentifier;
+declare function buildResource(scope: string, namespace: string, groupType: string, groupName: string, pod: string, container: string): string;
+interface ResourceIdentifier {
+    scope: string;
+    namespace: string;
+    set: string;
+    pod: string;
+    container: string;
+}
+export { accessKeyBuild, accessKeyCreate, accessKeyDeserialize, accessKeySerialize, AccessKey, parseResource, ResourceIdentifier, buildResource };

package/dist/AccessKey.js

@@ -0,0 +1,65 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildResource = exports.parseResource = exports.AccessKey = exports.accessKeySerialize = exports.accessKeyDeserialize = exports.accessKeyCreate = exports.accessKeyBuild = void 0;
+const guid_1 = __importDefault(require("guid"));
+/*
+    Access key format is:
+
+        id|type|resource
+    
+    where:
+        id: is a GUID
+        type: is volatile' or 'permanent' (the second type is persisted when created)
+        resource: is a stringified ResourceIdentifier
+*/
+class AccessKey {
+    constructor() {
+        this.id = '';
+        this.type = 'volatile';
+        this.resource = '';
+    }
+}
+exports.AccessKey = AccessKey;
+function accessKeyCreate(type, resource) {
+    var accessKey = new AccessKey();
+    accessKey.id = guid_1.default.create().toString();
+    accessKey.type = type;
+    accessKey.resource = resource;
+    return accessKey;
+}
+exports.accessKeyCreate = accessKeyCreate;
+function accessKeyBuild(id, type, resource) {
+    var accessKey = new AccessKey();
+    accessKey.id = id;
+    accessKey.type = type;
+    accessKey.resource = resource;
+    return accessKey;
+}
+exports.accessKeyBuild = accessKeyBuild;
+function accessKeySerialize(accessKey) {
+    return `${accessKey.id}|${accessKey.type}|${accessKey.resource}`;
+}
+exports.accessKeySerialize = accessKeySerialize;
+function accessKeyDeserialize(key) {
+    var parts = key.split('|');
+    return accessKeyBuild(parts[0], parts[1], parts[2]);
+}
+exports.accessKeyDeserialize = accessKeyDeserialize;
+function parseResource(key) {
+    var parts = key.split(':');
+    return {
+        scope: parts[0],
+        namespace: parts[1],
+        set: parts[2],
+        pod: parts[3],
+        container: parts[4]
+    };
+}
+exports.parseResource = parseResource;
+function buildResource(scope, namespace, groupType, groupName, pod, container) {
+    return `${scope}:${namespace}:${groupType}+${groupName}:${pod}:${container}`;
+}
+exports.buildResource = buildResource;

package/dist/ApiKey.d.ts

@@ -0,0 +1,6 @@
+import { AccessKey } from './AccessKey';
+export interface ApiKey {
+    accessKey: AccessKey;
+    description: string;
+    expire: number;
+}

package/dist/{Interfaces.d.ts → StreamMessage.d.ts}

@@ -1,4 +1,7 @@
 export interface StreamMessage {
+    namespace?: string;
+    podName?: string;
     type: string;
     text: string;
+    timestamp?: Date;
 }

package/dist/StreamMessage.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -1 +1,3 @@
-export { StreamMessage } from './Interfaces';
+export * from './StreamMessage';
+export * from './ApiKey';
+export * from './AccessKey';

package/dist/index.js

@@ -1,2 +1,34 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+/*
+Copyright 2024 Julio Fernandez
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+__exportStar(require("./StreamMessage"), exports);
+__exportStar(require("./ApiKey"), exports);
+__exportStar(require("./AccessKey"), exports);

package/package.json

@@ -1,15 +1,20 @@
 {
   "name": "@jfvilas/kwirth-common",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Common interfaces for integrating applications with Kwirth",
   "main": "index.js",
   "scripts": {
     "build": "del .\\dist\\* /s /q && tsc"
   },
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/jfvilas/kwirth-common.git"
-  },  
+  },
   "keywords": [
     "kwrith",
     "kubernetes",
@@ -22,5 +27,11 @@
   "bugs": {
     "url": "https://github.com/jfvilas/kwirth-common/issues"
   },
-  "homepage": "https://github.com/jfvilas/kwirth-common#readme"
+  "homepage": "https://github.com/jfvilas/kwirth-common#readme",
+  "dependencies": {
+    "guid": "^0.0.12"
+  },
+  "devDependencies": {
+    "@types/guid": "^1.0.3"
+  }
 }

package/src/AccessKey.ts

@@ -0,0 +1,122 @@
+import Guid from 'guid';
+
+/*
+    Access key format is:
+
+        id|type|resource
+    
+    where:
+        id: is a GUID
+        type: is volatile' or 'permanent' (the second type is persisted when created)
+        resource: is a stringified ResourceIdentifier
+*/
+class AccessKey {
+    public id:string='';
+    public type:string='volatile';
+    public resource:string='';
+}
+
+function accessKeyCreate(type:string, resource:string) : AccessKey {
+    var accessKey=new AccessKey();
+    accessKey.id=Guid.create().toString();
+    accessKey.type=type;
+    accessKey.resource=resource;
+    return accessKey;
+}
+
+function accessKeyBuild(id:string, type:string, resource:string) : AccessKey {
+    var accessKey=new AccessKey();
+    accessKey.id=id;
+    accessKey.type=type;
+    accessKey.resource=resource;
+    return accessKey;
+}
+
+function accessKeySerialize (accessKey:AccessKey) : string {
+    return `${accessKey.id}|${accessKey.type}|${accessKey.resource}`;
+}
+
+function accessKeyDeserialize (key:string) : AccessKey {
+    var parts=key.split('|');
+    return accessKeyBuild(parts[0], parts[1], parts[2]);
+}      
+
+function parseResource (key:string) : ResourceIdentifier {
+    var parts=key.split(':');
+    return {
+        scope:parts[0],
+        namespace:parts[1],
+        set:parts[2],
+        pod:parts[3],
+        container:parts[4]
+    }
+}
+
+function buildResource (scope:string, namespace:string, groupType:string, groupName:string, pod:string, container:string) : string {
+    return `${scope}:${namespace}:${groupType}+${groupName}:${pod}:${container}`;
+}
+
+/*
+    ResourceIdentifier is composed by:
+
+        scope can a comma-separated list of: cluster, api, view|filter, restart
+            cluster is the admin level, can do everything
+            api can create api keys
+            view or filter, can view logs
+            restart, can restart pods or deployments
+
+            for example, a user that can view and restart would have the scope 'view,restart'
+
+        NOTE: group is the type and name of a group: 'replica', 'stateful' or 'daemon', a plus sign ('+'), and the name of the group, example: 'replica+rs1', 'stateful+mongo'
+
+        the rest of fields are names (regex in fact) according to this rules:
+            - it can be a direct name, like: 'mynamespace', 'your-replicaset', 'our-pod'...
+            - it can be an '', indicating any resource of the scope is valid
+            - it can be a comma-separated list of names, like: namespace 'dev,pre', or pod 'my-pod,our-pod,your-pod'
+
+        full access is created by using cluster scope:
+            scope: cluster
+            namespace: ''
+            set: ''
+            pod: ''
+            container: ''
+
+        for example, an accessKey that gives access to view logs of namespaces production and staging would be something like
+            scope: view
+            namespace: ['production','staging']
+            set: ''
+            pod: ''
+            container: ''
+
+        access to restart any pod in 'development' namespace is like this:
+            scope: restart
+            namespace: 'development'
+            set: ''
+            pod: ''
+            container: ''
+
+        an accessKey that allows viewing logs of pod 'my-pod' in the whole cluster would be something like:
+            scope: view
+            namespace: ''
+            set: ''
+            pod: my-pod
+            container: ''      
+
+        the names are infact regex, so you, for allowing a requestor to restart any pod of the accounting application in preproduction environment you would use this:
+            scope: restart
+            namespace: 'preproduction'
+            set: ''
+            pod: '^account-'
+            container: ''      
+
+*/
+
+interface ResourceIdentifier {
+    scope:string,
+    namespace:string,
+    set:string,
+    pod:string,
+    container:string
+}
+
+export { accessKeyBuild, accessKeyCreate, accessKeyDeserialize, accessKeySerialize, AccessKey, parseResource, ResourceIdentifier, buildResource };

package/src/ApiKey.ts

@@ -0,0 +1,8 @@
+import { AccessKey } from './AccessKey';
+
+export interface ApiKey {
+    accessKey:AccessKey;
+    description:string;
+    expire:number;
+}
+

package/src/StreamMessage.ts

@@ -0,0 +1,7 @@
+export interface StreamMessage {
+    namespace?:string,
+    podName?:string,
+    type:string,
+    text:string,
+    timestamp?:Date
+}

package/src/index.ts

@@ -13,4 +13,6 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
-export { StreamMessage} from './Interfaces'
+export * from './StreamMessage'
+export * from './ApiKey'
+export * from './AccessKey'

package/src/Interfaces.ts

@@ -1,19 +0,0 @@
-/*
-Copyright 2024 Julio Fernandez
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-export interface StreamMessage {
-    type: string;
-    text: string;
-}