@jfvilas/kwirth-common 0.2.6 → 0.2.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jfvilas/kwirth-common",
-  "version": "0.2.6",
+  "version": "0.2.7",
   "description": "Common interfaces for integrating applications with Kwirth",
   "scripts": {
     "build": "del .\\dist\\* /s /q && tsc"
@@ -9,6 +9,12 @@
     "access": "public",
     "main": "dist/index.js"
   },
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/jfvilas/kwirth-common.git"

package/package copy.json

@@ -1,38 +0,0 @@
-{
-  "name": "@jfvilas/kwirth-common",
-  "version": "0.2.4",
-  "description": "Common interfaces for integrating applications with Kwirth",
-  "main": "src/index.ts",
-  "types": "src/index.ts",
-  "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",
-    "log",
-    "observability",
-    "kubelog"
-  ],
-  "author": "Julio Fernandez",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/jfvilas/kwirth-common/issues"
-  },
-  "homepage": "https://github.com/jfvilas/kwirth-common#readme",
-  "dependencies": {
-    "guid": "^0.0.12"
-  },
-  "devDependencies": {
-    "@types/guid": "^1.0.3"
-  }
-}

package/src/AccessKey.ts

@@ -1,122 +0,0 @@
-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

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

package/src/StreamMessage.ts

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

package/src/index.ts

@@ -1,18 +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 * from './StreamMessage'
-export * from './ApiKey'
-export * from './AccessKey'

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "include": [
-    "./src"
-  ],
-  "compilerOptions": {
-    "outDir": "dist",
-    "rootDir": "./src",
-    "module": "commonjs",
-    "target": "es6",
-    "strict": true,
-    "esModuleInterop": true,
-    "declaration": true,   
-  }
-}