@nsshunt/stsutils 1.16.9 → 1.16.11

package/dist/stsutils.mjs

@@ -167,10 +167,35 @@ function compareParameterTypes(source1, source2, authParameterTypes) {
   }
   return errors;
 }
+var ModelDelimeter = /* @__PURE__ */ ((ModelDelimeter2) => {
+  ModelDelimeter2["ROOT"] = "_";
+  ModelDelimeter2["SEPERATOR"] = "|";
+  ModelDelimeter2["COMPONENT_SEPERATOR"] = "@";
+  ModelDelimeter2["NID_SEPERATOR"] = "^";
+  return ModelDelimeter2;
+})(ModelDelimeter || {});
+const CheckValidChar = (checkParams) => {
+  const invalidChars = [
+    "_",
+    "|",
+    "@",
+    "^"
+    /* NID_SEPERATOR */
+  ];
+  checkParams.forEach((param) => {
+    invalidChars.forEach((char) => {
+      if (param[1].includes(char)) {
+        throw new Error(`Invalid character inside [${param[0]}:${param[1]}], no [${char}] allowed`);
+      }
+    });
+  });
+};
 export {
   AddSchema,
+  CheckValidChar,
   GetErrorPayload,
   JestSleep,
+  ModelDelimeter,
   OAuth2ParameterErrorType,
   OAuth2ParameterType,
   OIDCAddressClaim,

package/dist/stsutils.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"stsutils.mjs","sources":["../src/errorhandling.ts","../src/validate.ts","../src/stsoptionsbase.ts","../src/sleep.ts","../src/oauth2terms.ts"],"sourcesContent":["export type errorCode = {\n\tcode: string\n\tdescription: string\n}\n\nexport type errorPayload = {\n\terror: string,\n\terror_description: string,\n\ttimestamp: number,\n\t//trace_id: \"255d1aef-8c98-452f-ac51-23d051240864\", //@@\n\t//correlation_id: \"fb3d2015-bc17-4bb9-bb85-30c5cf1aaaa7\", //@@\n\tdetails?: unknown\n}\n\nexport function GetErrorPayload(errorCode: errorCode, details: unknown = null): errorPayload {\n    return {\n        error: errorCode.code,\n        error_description: errorCode.description,\n        timestamp: Date.now(),\n        //trace_id: \"255d1aef-8c98-452f-ac51-23d051240864\", //@@\n        //correlation_id: \"fb3d2015-bc17-4bb9-bb85-30c5cf1aaaa7\", //@@\n        details: details\n    }\n}\n","import Ajv, { Schema } from 'ajv/dist/jtd.js'\nimport { AnyValidateFunction } from 'ajv/dist/core.js';\n\nimport { JSONObject } from './index'\n\nconst ajv = new Ajv();\n\nconst _Validate = (validator: AnyValidateFunction<unknown>, payload: JSONObject): unknown | null => {\n    const valid: boolean = validator(payload) as boolean;\n    if (!valid) {\n        return validator.errors;\n    } else {\n        return null;\n    }\n    /*\n\t\tconsole.error(validator.errors);\n\t\tconsole.trace('Invalid Schema');\n\t\tconsole.log('Payload:-');\n\t\tconsole.log(JSON.stringify(payload));\n\t\tprocess.exit(1);\n\t\t*/\n};\n\nexport function AddSchema(name: string, schema: Schema): void {\n    ajv.addSchema(schema, name);\n    /*\n\treturn (payload) => {\n\t\tconst validator = ajv.getSchema(name)\n\t\t_Validate(validator, payload)\n\t}*/\n\n}\n\nexport function Validate(name: string, payload: JSONObject): unknown {\n    const validator: AnyValidateFunction<unknown> | undefined = ajv.getSchema(name)\n    if (validator) {\n        return _Validate(validator, payload);\n    }\n}\n","import { Validate } from './validate.js'\n\nimport { JSONObject } from './index'\n\nexport class STSOptionsBase\n{\n    #options: JSONObject | null;\n\n    constructor(options: JSONObject | null = null)\n    {\n        this.#options = options;\n\n        if (options !== null) {\n            if (typeof options.validator === 'undefined') {\n                //console.log(JSON.stringify(options));\n                //console.trace(\"Options Here ------------------------------------------------------------------------------------------\")\n            } else {\n                Validate(options.validator as string, options);\n            }\n        }\n    }\n\n    get options()\n    {\n        return this.#options;\n    }\n}\n","export async function Sleep(milliseconds = 1000): Promise<void> { \n    return new Promise(resolve => setTimeout(resolve, milliseconds))\n}\n  \n// poolsleep is required to avoid JEST reporting unclosed handles during shutdown of all tests\nexport async function JestSleep(): Promise<void> {\n    return Sleep(100);\n}\n","import { errorCode, errorPayload } from './errorhandling'\n\n// Ref: https://datatracker.ietf.org/doc/html/rfc6749#appendix-A\nexport enum OAuth2ParameterType {\n\tAUDIENCE = 'AUDIENCE', // STS Extension\n\tCLIENT_ID = 'client_id',\n\tCLIENT_SECRET = 'client_secret',\n\tRESPONSE_TYPE = 'response_type',\n\tSCOPE = 'scope',\n\tSTATE = 'state',\n\tREDIRECT_URI = 'redirect_uri',\n\tERROR = 'error',\n\tERROR_DESCRIPTION = 'error_description',\n\tERROR_CODES = 'error_codes', // STS Extension\n\tERROR_URI = 'error_uri',\n\tGRANT_TYPE = 'grant_type',\n\tCODE = 'code',\n\tACCESS_TOKEN = 'access_token',\n\tTOKEN_TYPE = 'token_type',\n\tEXPIRES_IN = 'expires_in',\n\tUSERNAME = 'username',\n\tPASSWORD = 'password',\n\tREFRESH_TOKEN = 'refresh_token',\n\tRESPONSE_MODE = 'response_mode', // STS Extension\n\tTIMESTAMP = 'timestamp', // STS Extension\n\tTRACE_ID = 'trace_id', // STS Extension\n\tCORRELATION_ID = 'correlation_id' // STS Extension\n}\n\n// OIDC Standard Claims\n// Ref: https://openid.net/specs/openid-connect-core-1_0.html#Claims\nexport enum OIDCStandardClaim {\n\tSUB = 'sub',\n\tNAME = 'name',\n\tGIVEN_NAME = 'given_name',\n\tFAMILY_NAME = 'family_name',\n\tMIDDLE_NAME = 'middle_name',\n\tNICKNAME = 'nickname',\n\tPREFERRED_USERNAME = 'preferred_username',\n\tPROFILE = 'profile',\n\tPICTURE = 'picture',\n\tWEBSITE = 'website',\n\tEMAIL = 'email',\n\tEMAIL_VERIFIED = 'email_verified',\n\tGENDER = 'gender',\n\tBIRTHDATE = 'birthdate',\n\tZONEINFO = 'zoneinfo',\n\tLOCALE = 'locale',\n\tPHONE_NUMBER = 'phone_number',\n\tPHONE_NUMBER_VERIFIED = 'phone_number_verified',\n\tADDRESS = 'address',\n\tCLIENT_SECRET = 'client_secret',\n\tNONCE = 'nonce' // STS Extension\n}\n\nexport enum OIDCAddressClaim {\n\tFORMATTED = 'formatted',\n\tSTREET_ADDRESS = 'street_address',\n\tLOCALITY = 'locality',\n\tREGION = 'region',\n\tCOUNTRY = 'country'\n}\n\nexport class OAuth2ParameterErrorType {\n    static readonly NOT_EQUAL: errorCode = {\n        code: 'STS_OAUTH2_ERR_0001',\n        description: 'Parameter values not equal.'\n    }\n    static readonly NOT_PRESENT: errorCode = {\n        code: 'STS_OAUTH2_ERR_0002',\n        description: 'Parameter not provided.'\n    }\n    static readonly INVALID_FORMAT: errorCode = {\n        code: 'STS_OAUTH2_ERR_0003',\n        description: 'Parameter value format invalid.'\n    }\n    static readonly EXPIRED: errorCode = {\n        code: 'STS_OAUTH2_ERR_0004',\n        description: 'Parameter value expired.'\n    }\n}\n\nexport function compareParameterTypes(source1: string[], source2: string[], authParameterTypes: OAuth2ParameterType[]): errorPayload[] {\n    const errors: errorPayload[] = [ ];\n    for (let i=0 ; i < authParameterTypes.length; i++) {\n        const authParameterType = authParameterTypes[i];\n        if (source1[i].localeCompare(source2[i]) !== 0) {\n            const error: errorPayload = {\n                error: OAuth2ParameterErrorType.NOT_EQUAL.code,\n                error_description: OAuth2ParameterErrorType.NOT_EQUAL.description,\n                timestamp: Date.now(),\n                details: `${OAuth2ParameterErrorType.NOT_EQUAL.description}: Parameter: [${authParameterType}]`\n            }\n            errors.push(error);\n        }\n    }\n    return errors;\n}\n"],"names":["OAuth2ParameterType","OIDCStandardClaim","OIDCAddressClaim"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAcgB,SAAA,gBAAgB,WAAsB,UAAmB,MAAoB;AAClF,SAAA;AAAA,IACH,OAAO,UAAU;AAAA,IACjB,mBAAmB,UAAU;AAAA,IAC7B,WAAW,KAAK,IAAI;AAAA;AAAA;AAAA,IAGpB;AAAA,EAAA;AAER;AClBA,MAAM,MAAM,IAAI;AAEhB,MAAM,YAAY,CAAC,WAAyC,YAAwC;AAC1F,QAAA,QAAiB,UAAU,OAAO;AACxC,MAAI,CAAC,OAAO;AACR,WAAO,UAAU;AAAA,EAAA,OACd;AACI,WAAA;AAAA,EACX;AAQJ;AAEgB,SAAA,UAAU,MAAc,QAAsB;AACtD,MAAA,UAAU,QAAQ,IAAI;AAO9B;AAEgB,SAAA,SAAS,MAAc,SAA8B;AAC3D,QAAA,YAAsD,IAAI,UAAU,IAAI;AAC9E,MAAI,WAAW;AACJ,WAAA,UAAU,WAAW,OAAO;AAAA,EACvC;AACJ;AClCO,MAAM,eACb;AAAA,EAGI,YAAY,UAA6B,MACzC;AAHA;AAII,uBAAK,UAAW;AAEhB,QAAI,YAAY,MAAM;AACd,UAAA,OAAO,QAAQ,cAAc;AAAa;AAAA,WAGvC;AACM,iBAAA,QAAQ,WAAqB,OAAO;AAAA,MACjD;AAAA,IACJ;AAAA,EACJ;AAAA,EAEA,IAAI,UACJ;AACI,WAAO,mBAAK;AAAA,EAChB;AACJ;AApBI;ACNkB,eAAA,MAAM,eAAe,KAAqB;AAC5D,SAAO,IAAI,QAAQ,CAAA,YAAW,WAAW,SAAS,YAAY,CAAC;AACnE;AAGA,eAAsB,YAA2B;AAC7C,SAAO,MAAM,GAAG;AACpB;ACJY,IAAA,wCAAAA,yBAAL;AACNA,uBAAA,UAAW,IAAA;AACXA,uBAAA,WAAY,IAAA;AACZA,uBAAA,eAAgB,IAAA;AAChBA,uBAAA,eAAgB,IAAA;AAChBA,uBAAA,OAAQ,IAAA;AACRA,uBAAA,OAAQ,IAAA;AACRA,uBAAA,cAAe,IAAA;AACfA,uBAAA,OAAQ,IAAA;AACRA,uBAAA,mBAAoB,IAAA;AACpBA,uBAAA,aAAc,IAAA;AACdA,uBAAA,WAAY,IAAA;AACZA,uBAAA,YAAa,IAAA;AACbA,uBAAA,MAAO,IAAA;AACPA,uBAAA,cAAe,IAAA;AACfA,uBAAA,YAAa,IAAA;AACbA,uBAAA,YAAa,IAAA;AACbA,uBAAA,UAAW,IAAA;AACXA,uBAAA,UAAW,IAAA;AACXA,uBAAA,eAAgB,IAAA;AAChBA,uBAAA,eAAgB,IAAA;AAChBA,uBAAA,WAAY,IAAA;AACZA,uBAAA,UAAW,IAAA;AACXA,uBAAA,gBAAiB,IAAA;AAvBNA,SAAAA;AAAA,GAAA,uBAAA,CAAA,CAAA;AA4BA,IAAA,sCAAAC,uBAAL;AACNA,qBAAA,KAAM,IAAA;AACNA,qBAAA,MAAO,IAAA;AACPA,qBAAA,YAAa,IAAA;AACbA,qBAAA,aAAc,IAAA;AACdA,qBAAA,aAAc,IAAA;AACdA,qBAAA,UAAW,IAAA;AACXA,qBAAA,oBAAqB,IAAA;AACrBA,qBAAA,SAAU,IAAA;AACVA,qBAAA,SAAU,IAAA;AACVA,qBAAA,SAAU,IAAA;AACVA,qBAAA,OAAQ,IAAA;AACRA,qBAAA,gBAAiB,IAAA;AACjBA,qBAAA,QAAS,IAAA;AACTA,qBAAA,WAAY,IAAA;AACZA,qBAAA,UAAW,IAAA;AACXA,qBAAA,QAAS,IAAA;AACTA,qBAAA,cAAe,IAAA;AACfA,qBAAA,uBAAwB,IAAA;AACxBA,qBAAA,SAAU,IAAA;AACVA,qBAAA,eAAgB,IAAA;AAChBA,qBAAA,OAAQ,IAAA;AArBGA,SAAAA;AAAA,GAAA,qBAAA,CAAA,CAAA;AAwBA,IAAA,qCAAAC,sBAAL;AACNA,oBAAA,WAAY,IAAA;AACZA,oBAAA,gBAAiB,IAAA;AACjBA,oBAAA,UAAW,IAAA;AACXA,oBAAA,QAAS,IAAA;AACTA,oBAAA,SAAU,IAAA;AALCA,SAAAA;AAAA,GAAA,oBAAA,CAAA,CAAA;AAQL,MAAM,yBAAyB;AAiBtC;AAhBI,cADS,0BACO,aAAuB;AAAA,EACnC,MAAM;AAAA,EACN,aAAa;AAAA;AAEjB,cALS,0BAKO,eAAyB;AAAA,EACrC,MAAM;AAAA,EACN,aAAa;AAAA;AAEjB,cATS,0BASO,kBAA4B;AAAA,EACxC,MAAM;AAAA,EACN,aAAa;AAAA;AAEjB,cAbS,0BAaO,WAAqB;AAAA,EACjC,MAAM;AAAA,EACN,aAAa;AAAA;AAIL,SAAA,sBAAsB,SAAmB,SAAmB,oBAA2D;AACnI,QAAM,SAAyB,CAAA;AAC/B,WAAS,IAAE,GAAI,IAAI,mBAAmB,QAAQ,KAAK;AACzC,UAAA,oBAAoB,mBAAmB,CAAC;AAC1C,QAAA,QAAQ,CAAC,EAAE,cAAc,QAAQ,CAAC,CAAC,MAAM,GAAG;AAC5C,YAAM,QAAsB;AAAA,QACxB,OAAO,yBAAyB,UAAU;AAAA,QAC1C,mBAAmB,yBAAyB,UAAU;AAAA,QACtD,WAAW,KAAK,IAAI;AAAA,QACpB,SAAS,GAAG,yBAAyB,UAAU,WAAW,iBAAiB,iBAAiB;AAAA,MAAA;AAEhG,aAAO,KAAK,KAAK;AAAA,IACrB;AAAA,EACJ;AACO,SAAA;AACX;"}
+{"version":3,"file":"stsutils.mjs","sources":["../src/errorhandling.ts","../src/validate.ts","../src/stsoptionsbase.ts","../src/sleep.ts","../src/oauth2terms.ts","../src/index.ts"],"sourcesContent":["export type errorCode = {\n\tcode: string\n\tdescription: string\n}\n\nexport type errorPayload = {\n\terror: string,\n\terror_description: string,\n\ttimestamp: number,\n\t//trace_id: \"255d1aef-8c98-452f-ac51-23d051240864\", //@@\n\t//correlation_id: \"fb3d2015-bc17-4bb9-bb85-30c5cf1aaaa7\", //@@\n\tdetails?: unknown\n}\n\nexport function GetErrorPayload(errorCode: errorCode, details: unknown = null): errorPayload {\n    return {\n        error: errorCode.code,\n        error_description: errorCode.description,\n        timestamp: Date.now(),\n        //trace_id: \"255d1aef-8c98-452f-ac51-23d051240864\", //@@\n        //correlation_id: \"fb3d2015-bc17-4bb9-bb85-30c5cf1aaaa7\", //@@\n        details: details\n    }\n}\n","import Ajv, { Schema } from 'ajv/dist/jtd.js'\nimport { AnyValidateFunction } from 'ajv/dist/core.js';\n\nimport { JSONObject } from './index'\n\nconst ajv = new Ajv();\n\nconst _Validate = (validator: AnyValidateFunction<unknown>, payload: JSONObject): unknown | null => {\n    const valid: boolean = validator(payload) as boolean;\n    if (!valid) {\n        return validator.errors;\n    } else {\n        return null;\n    }\n    /*\n\t\tconsole.error(validator.errors);\n\t\tconsole.trace('Invalid Schema');\n\t\tconsole.log('Payload:-');\n\t\tconsole.log(JSON.stringify(payload));\n\t\tprocess.exit(1);\n\t\t*/\n};\n\nexport function AddSchema(name: string, schema: Schema): void {\n    ajv.addSchema(schema, name);\n    /*\n\treturn (payload) => {\n\t\tconst validator = ajv.getSchema(name)\n\t\t_Validate(validator, payload)\n\t}*/\n\n}\n\nexport function Validate(name: string, payload: JSONObject): unknown {\n    const validator: AnyValidateFunction<unknown> | undefined = ajv.getSchema(name)\n    if (validator) {\n        return _Validate(validator, payload);\n    }\n}\n","import { Validate } from './validate.js'\n\nimport { JSONObject } from './index'\n\nexport class STSOptionsBase\n{\n    #options: JSONObject | null;\n\n    constructor(options: JSONObject | null = null)\n    {\n        this.#options = options;\n\n        if (options !== null) {\n            if (typeof options.validator === 'undefined') {\n                //console.log(JSON.stringify(options));\n                //console.trace(\"Options Here ------------------------------------------------------------------------------------------\")\n            } else {\n                Validate(options.validator as string, options);\n            }\n        }\n    }\n\n    get options()\n    {\n        return this.#options;\n    }\n}\n","export async function Sleep(milliseconds = 1000): Promise<void> { \n    return new Promise(resolve => setTimeout(resolve, milliseconds))\n}\n  \n// poolsleep is required to avoid JEST reporting unclosed handles during shutdown of all tests\nexport async function JestSleep(): Promise<void> {\n    return Sleep(100);\n}\n","import { errorCode, errorPayload } from './errorhandling'\n\n// Ref: https://datatracker.ietf.org/doc/html/rfc6749#appendix-A\nexport enum OAuth2ParameterType {\n\tAUDIENCE = 'AUDIENCE', // STS Extension\n\tCLIENT_ID = 'client_id',\n\tCLIENT_SECRET = 'client_secret',\n\tRESPONSE_TYPE = 'response_type',\n\tSCOPE = 'scope',\n\tSTATE = 'state',\n\tREDIRECT_URI = 'redirect_uri',\n\tERROR = 'error',\n\tERROR_DESCRIPTION = 'error_description',\n\tERROR_CODES = 'error_codes', // STS Extension\n\tERROR_URI = 'error_uri',\n\tGRANT_TYPE = 'grant_type',\n\tCODE = 'code',\n\tACCESS_TOKEN = 'access_token',\n\tTOKEN_TYPE = 'token_type',\n\tEXPIRES_IN = 'expires_in',\n\tUSERNAME = 'username',\n\tPASSWORD = 'password',\n\tREFRESH_TOKEN = 'refresh_token',\n\tRESPONSE_MODE = 'response_mode', // STS Extension\n\tTIMESTAMP = 'timestamp', // STS Extension\n\tTRACE_ID = 'trace_id', // STS Extension\n\tCORRELATION_ID = 'correlation_id' // STS Extension\n}\n\n// OIDC Standard Claims\n// Ref: https://openid.net/specs/openid-connect-core-1_0.html#Claims\nexport enum OIDCStandardClaim {\n\tSUB = 'sub',\n\tNAME = 'name',\n\tGIVEN_NAME = 'given_name',\n\tFAMILY_NAME = 'family_name',\n\tMIDDLE_NAME = 'middle_name',\n\tNICKNAME = 'nickname',\n\tPREFERRED_USERNAME = 'preferred_username',\n\tPROFILE = 'profile',\n\tPICTURE = 'picture',\n\tWEBSITE = 'website',\n\tEMAIL = 'email',\n\tEMAIL_VERIFIED = 'email_verified',\n\tGENDER = 'gender',\n\tBIRTHDATE = 'birthdate',\n\tZONEINFO = 'zoneinfo',\n\tLOCALE = 'locale',\n\tPHONE_NUMBER = 'phone_number',\n\tPHONE_NUMBER_VERIFIED = 'phone_number_verified',\n\tADDRESS = 'address',\n\tCLIENT_SECRET = 'client_secret',\n\tNONCE = 'nonce' // STS Extension\n}\n\nexport enum OIDCAddressClaim {\n\tFORMATTED = 'formatted',\n\tSTREET_ADDRESS = 'street_address',\n\tLOCALITY = 'locality',\n\tREGION = 'region',\n\tCOUNTRY = 'country'\n}\n\nexport class OAuth2ParameterErrorType {\n    static readonly NOT_EQUAL: errorCode = {\n        code: 'STS_OAUTH2_ERR_0001',\n        description: 'Parameter values not equal.'\n    }\n    static readonly NOT_PRESENT: errorCode = {\n        code: 'STS_OAUTH2_ERR_0002',\n        description: 'Parameter not provided.'\n    }\n    static readonly INVALID_FORMAT: errorCode = {\n        code: 'STS_OAUTH2_ERR_0003',\n        description: 'Parameter value format invalid.'\n    }\n    static readonly EXPIRED: errorCode = {\n        code: 'STS_OAUTH2_ERR_0004',\n        description: 'Parameter value expired.'\n    }\n}\n\nexport function compareParameterTypes(source1: string[], source2: string[], authParameterTypes: OAuth2ParameterType[]): errorPayload[] {\n    const errors: errorPayload[] = [ ];\n    for (let i=0 ; i < authParameterTypes.length; i++) {\n        const authParameterType = authParameterTypes[i];\n        if (source1[i].localeCompare(source2[i]) !== 0) {\n            const error: errorPayload = {\n                error: OAuth2ParameterErrorType.NOT_EQUAL.code,\n                error_description: OAuth2ParameterErrorType.NOT_EQUAL.description,\n                timestamp: Date.now(),\n                details: `${OAuth2ParameterErrorType.NOT_EQUAL.description}: Parameter: [${authParameterType}]`\n            }\n            errors.push(error);\n        }\n    }\n    return errors;\n}\n","/*\nexport interface JSONObject {\n    [x: string]: string | number | boolean | string[] | number[] | boolean[] | Array<JSONObject> | JSONObject | ((p: any) => any) | undefined\n}\n// This also works :-\n//interface JSONObject2 extends Record<string, string | number | string[] | Array<JSONObject2> | JSONObject2> {};\n*/\n\nexport interface JSONObject {\n    // eslint-disable-next-line  @typescript-eslint/no-explicit-any\n    [x: string]: any | JSONObject | undefined\n}\n\nexport * from './errorhandling'\nexport * from './stsoptionsbase'\nexport * from './sleep'\nexport * from './validate'\nexport * from './oauth2terms'\n\nexport enum ModelDelimeter {\n\tROOT = '_',\n\tSEPERATOR = '|',\n\tCOMPONENT_SEPERATOR = '@',\n\tNID_SEPERATOR = '^' // This seperator splits the static and dynamic part of a context string (nid). Used for creating payload header for size optimisation.\n}\n\nexport const CheckValidChar = (checkParams: string[][]): void => {\n    const invalidChars = [ \n        ModelDelimeter.ROOT, \n        ModelDelimeter.SEPERATOR, \n        ModelDelimeter.COMPONENT_SEPERATOR, \n        ModelDelimeter.NID_SEPERATOR\n    ];\n\n    checkParams.forEach(param => {\n        invalidChars.forEach(char => {\n            if (param[1].includes(char)) {\n                throw new Error(`Invalid character inside [${param[0]}:${param[1]}], no [${char}] allowed`);\n            }\n        });\n    });\n}\n\n/* Below is legacy code used as a global record container. No longer required.\n// eslint-disable-next-line  @typescript-eslint/no-explicit-any\nexport const $stsgd: Record<string, any> = { };\n\nexport function $stsgdf<T>(): Record<string, T> {\n    return $stsgd as Record<string, T>;\n}\n*/\n"],"names":["OAuth2ParameterType","OIDCStandardClaim","OIDCAddressClaim","ModelDelimeter"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAcgB,SAAA,gBAAgB,WAAsB,UAAmB,MAAoB;AAClF,SAAA;AAAA,IACH,OAAO,UAAU;AAAA,IACjB,mBAAmB,UAAU;AAAA,IAC7B,WAAW,KAAK,IAAI;AAAA;AAAA;AAAA,IAGpB;AAAA,EAAA;AAER;AClBA,MAAM,MAAM,IAAI;AAEhB,MAAM,YAAY,CAAC,WAAyC,YAAwC;AAC1F,QAAA,QAAiB,UAAU,OAAO;AACxC,MAAI,CAAC,OAAO;AACR,WAAO,UAAU;AAAA,EAAA,OACd;AACI,WAAA;AAAA,EACX;AAQJ;AAEgB,SAAA,UAAU,MAAc,QAAsB;AACtD,MAAA,UAAU,QAAQ,IAAI;AAO9B;AAEgB,SAAA,SAAS,MAAc,SAA8B;AAC3D,QAAA,YAAsD,IAAI,UAAU,IAAI;AAC9E,MAAI,WAAW;AACJ,WAAA,UAAU,WAAW,OAAO;AAAA,EACvC;AACJ;AClCO,MAAM,eACb;AAAA,EAGI,YAAY,UAA6B,MACzC;AAHA;AAII,uBAAK,UAAW;AAEhB,QAAI,YAAY,MAAM;AACd,UAAA,OAAO,QAAQ,cAAc;AAAa;AAAA,WAGvC;AACM,iBAAA,QAAQ,WAAqB,OAAO;AAAA,MACjD;AAAA,IACJ;AAAA,EACJ;AAAA,EAEA,IAAI,UACJ;AACI,WAAO,mBAAK;AAAA,EAChB;AACJ;AApBI;ACNkB,eAAA,MAAM,eAAe,KAAqB;AAC5D,SAAO,IAAI,QAAQ,CAAA,YAAW,WAAW,SAAS,YAAY,CAAC;AACnE;AAGA,eAAsB,YAA2B;AAC7C,SAAO,MAAM,GAAG;AACpB;ACJY,IAAA,wCAAAA,yBAAL;AACNA,uBAAA,UAAW,IAAA;AACXA,uBAAA,WAAY,IAAA;AACZA,uBAAA,eAAgB,IAAA;AAChBA,uBAAA,eAAgB,IAAA;AAChBA,uBAAA,OAAQ,IAAA;AACRA,uBAAA,OAAQ,IAAA;AACRA,uBAAA,cAAe,IAAA;AACfA,uBAAA,OAAQ,IAAA;AACRA,uBAAA,mBAAoB,IAAA;AACpBA,uBAAA,aAAc,IAAA;AACdA,uBAAA,WAAY,IAAA;AACZA,uBAAA,YAAa,IAAA;AACbA,uBAAA,MAAO,IAAA;AACPA,uBAAA,cAAe,IAAA;AACfA,uBAAA,YAAa,IAAA;AACbA,uBAAA,YAAa,IAAA;AACbA,uBAAA,UAAW,IAAA;AACXA,uBAAA,UAAW,IAAA;AACXA,uBAAA,eAAgB,IAAA;AAChBA,uBAAA,eAAgB,IAAA;AAChBA,uBAAA,WAAY,IAAA;AACZA,uBAAA,UAAW,IAAA;AACXA,uBAAA,gBAAiB,IAAA;AAvBNA,SAAAA;AAAA,GAAA,uBAAA,CAAA,CAAA;AA4BA,IAAA,sCAAAC,uBAAL;AACNA,qBAAA,KAAM,IAAA;AACNA,qBAAA,MAAO,IAAA;AACPA,qBAAA,YAAa,IAAA;AACbA,qBAAA,aAAc,IAAA;AACdA,qBAAA,aAAc,IAAA;AACdA,qBAAA,UAAW,IAAA;AACXA,qBAAA,oBAAqB,IAAA;AACrBA,qBAAA,SAAU,IAAA;AACVA,qBAAA,SAAU,IAAA;AACVA,qBAAA,SAAU,IAAA;AACVA,qBAAA,OAAQ,IAAA;AACRA,qBAAA,gBAAiB,IAAA;AACjBA,qBAAA,QAAS,IAAA;AACTA,qBAAA,WAAY,IAAA;AACZA,qBAAA,UAAW,IAAA;AACXA,qBAAA,QAAS,IAAA;AACTA,qBAAA,cAAe,IAAA;AACfA,qBAAA,uBAAwB,IAAA;AACxBA,qBAAA,SAAU,IAAA;AACVA,qBAAA,eAAgB,IAAA;AAChBA,qBAAA,OAAQ,IAAA;AArBGA,SAAAA;AAAA,GAAA,qBAAA,CAAA,CAAA;AAwBA,IAAA,qCAAAC,sBAAL;AACNA,oBAAA,WAAY,IAAA;AACZA,oBAAA,gBAAiB,IAAA;AACjBA,oBAAA,UAAW,IAAA;AACXA,oBAAA,QAAS,IAAA;AACTA,oBAAA,SAAU,IAAA;AALCA,SAAAA;AAAA,GAAA,oBAAA,CAAA,CAAA;AAQL,MAAM,yBAAyB;AAiBtC;AAhBI,cADS,0BACO,aAAuB;AAAA,EACnC,MAAM;AAAA,EACN,aAAa;AAAA;AAEjB,cALS,0BAKO,eAAyB;AAAA,EACrC,MAAM;AAAA,EACN,aAAa;AAAA;AAEjB,cATS,0BASO,kBAA4B;AAAA,EACxC,MAAM;AAAA,EACN,aAAa;AAAA;AAEjB,cAbS,0BAaO,WAAqB;AAAA,EACjC,MAAM;AAAA,EACN,aAAa;AAAA;AAIL,SAAA,sBAAsB,SAAmB,SAAmB,oBAA2D;AACnI,QAAM,SAAyB,CAAA;AAC/B,WAAS,IAAE,GAAI,IAAI,mBAAmB,QAAQ,KAAK;AACzC,UAAA,oBAAoB,mBAAmB,CAAC;AAC1C,QAAA,QAAQ,CAAC,EAAE,cAAc,QAAQ,CAAC,CAAC,MAAM,GAAG;AAC5C,YAAM,QAAsB;AAAA,QACxB,OAAO,yBAAyB,UAAU;AAAA,QAC1C,mBAAmB,yBAAyB,UAAU;AAAA,QACtD,WAAW,KAAK,IAAI;AAAA,QACpB,SAAS,GAAG,yBAAyB,UAAU,WAAW,iBAAiB,iBAAiB;AAAA,MAAA;AAEhG,aAAO,KAAK,KAAK;AAAA,IACrB;AAAA,EACJ;AACO,SAAA;AACX;AC9EY,IAAA,mCAAAC,oBAAL;AACNA,kBAAA,MAAO,IAAA;AACPA,kBAAA,WAAY,IAAA;AACZA,kBAAA,qBAAsB,IAAA;AACtBA,kBAAA,eAAgB,IAAA;AAJLA,SAAAA;AAAA,GAAA,kBAAA,CAAA,CAAA;AAOC,MAAA,iBAAiB,CAAC,gBAAkC;AAC7D,QAAM,eAAe;AAAA,IACjB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA;AAAA,EAAA;AAGJ,cAAY,QAAQ,CAAS,UAAA;AACzB,iBAAa,QAAQ,CAAQ,SAAA;AACzB,UAAI,MAAM,CAAC,EAAE,SAAS,IAAI,GAAG;AACzB,cAAM,IAAI,MAAM,6BAA6B,MAAM,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,UAAU,IAAI,WAAW;AAAA,MAC9F;AAAA,IAAA,CACH;AAAA,EAAA,CACJ;AACL;"}

package/dist/stsutils.umd.js

@@ -170,9 +170,34 @@ var __privateSet = (obj, member, value, setter) => {
     }
     return errors;
   }
+  var ModelDelimeter = /* @__PURE__ */ ((ModelDelimeter2) => {
+    ModelDelimeter2["ROOT"] = "_";
+    ModelDelimeter2["SEPERATOR"] = "|";
+    ModelDelimeter2["COMPONENT_SEPERATOR"] = "@";
+    ModelDelimeter2["NID_SEPERATOR"] = "^";
+    return ModelDelimeter2;
+  })(ModelDelimeter || {});
+  const CheckValidChar = (checkParams) => {
+    const invalidChars = [
+      "_",
+      "|",
+      "@",
+      "^"
+      /* NID_SEPERATOR */
+    ];
+    checkParams.forEach((param) => {
+      invalidChars.forEach((char) => {
+        if (param[1].includes(char)) {
+          throw new Error(`Invalid character inside [${param[0]}:${param[1]}], no [${char}] allowed`);
+        }
+      });
+    });
+  };
   exports2.AddSchema = AddSchema;
+  exports2.CheckValidChar = CheckValidChar;
   exports2.GetErrorPayload = GetErrorPayload;
   exports2.JestSleep = JestSleep;
+  exports2.ModelDelimeter = ModelDelimeter;
   exports2.OAuth2ParameterErrorType = OAuth2ParameterErrorType;
   exports2.OAuth2ParameterType = OAuth2ParameterType;
   exports2.OIDCAddressClaim = OIDCAddressClaim;

package/dist/stsutils.umd.js.map

@@ -1 +1 @@
-{"version":3,"file":"stsutils.umd.js","sources":["../src/errorhandling.ts","../src/validate.ts","../src/stsoptionsbase.ts","../src/sleep.ts","../src/oauth2terms.ts"],"sourcesContent":["export type errorCode = {\n\tcode: string\n\tdescription: string\n}\n\nexport type errorPayload = {\n\terror: string,\n\terror_description: string,\n\ttimestamp: number,\n\t//trace_id: \"255d1aef-8c98-452f-ac51-23d051240864\", //@@\n\t//correlation_id: \"fb3d2015-bc17-4bb9-bb85-30c5cf1aaaa7\", //@@\n\tdetails?: unknown\n}\n\nexport function GetErrorPayload(errorCode: errorCode, details: unknown = null): errorPayload {\n    return {\n        error: errorCode.code,\n        error_description: errorCode.description,\n        timestamp: Date.now(),\n        //trace_id: \"255d1aef-8c98-452f-ac51-23d051240864\", //@@\n        //correlation_id: \"fb3d2015-bc17-4bb9-bb85-30c5cf1aaaa7\", //@@\n        details: details\n    }\n}\n","import Ajv, { Schema } from 'ajv/dist/jtd.js'\nimport { AnyValidateFunction } from 'ajv/dist/core.js';\n\nimport { JSONObject } from './index'\n\nconst ajv = new Ajv();\n\nconst _Validate = (validator: AnyValidateFunction<unknown>, payload: JSONObject): unknown | null => {\n    const valid: boolean = validator(payload) as boolean;\n    if (!valid) {\n        return validator.errors;\n    } else {\n        return null;\n    }\n    /*\n\t\tconsole.error(validator.errors);\n\t\tconsole.trace('Invalid Schema');\n\t\tconsole.log('Payload:-');\n\t\tconsole.log(JSON.stringify(payload));\n\t\tprocess.exit(1);\n\t\t*/\n};\n\nexport function AddSchema(name: string, schema: Schema): void {\n    ajv.addSchema(schema, name);\n    /*\n\treturn (payload) => {\n\t\tconst validator = ajv.getSchema(name)\n\t\t_Validate(validator, payload)\n\t}*/\n\n}\n\nexport function Validate(name: string, payload: JSONObject): unknown {\n    const validator: AnyValidateFunction<unknown> | undefined = ajv.getSchema(name)\n    if (validator) {\n        return _Validate(validator, payload);\n    }\n}\n","import { Validate } from './validate.js'\n\nimport { JSONObject } from './index'\n\nexport class STSOptionsBase\n{\n    #options: JSONObject | null;\n\n    constructor(options: JSONObject | null = null)\n    {\n        this.#options = options;\n\n        if (options !== null) {\n            if (typeof options.validator === 'undefined') {\n                //console.log(JSON.stringify(options));\n                //console.trace(\"Options Here ------------------------------------------------------------------------------------------\")\n            } else {\n                Validate(options.validator as string, options);\n            }\n        }\n    }\n\n    get options()\n    {\n        return this.#options;\n    }\n}\n","export async function Sleep(milliseconds = 1000): Promise<void> { \n    return new Promise(resolve => setTimeout(resolve, milliseconds))\n}\n  \n// poolsleep is required to avoid JEST reporting unclosed handles during shutdown of all tests\nexport async function JestSleep(): Promise<void> {\n    return Sleep(100);\n}\n","import { errorCode, errorPayload } from './errorhandling'\n\n// Ref: https://datatracker.ietf.org/doc/html/rfc6749#appendix-A\nexport enum OAuth2ParameterType {\n\tAUDIENCE = 'AUDIENCE', // STS Extension\n\tCLIENT_ID = 'client_id',\n\tCLIENT_SECRET = 'client_secret',\n\tRESPONSE_TYPE = 'response_type',\n\tSCOPE = 'scope',\n\tSTATE = 'state',\n\tREDIRECT_URI = 'redirect_uri',\n\tERROR = 'error',\n\tERROR_DESCRIPTION = 'error_description',\n\tERROR_CODES = 'error_codes', // STS Extension\n\tERROR_URI = 'error_uri',\n\tGRANT_TYPE = 'grant_type',\n\tCODE = 'code',\n\tACCESS_TOKEN = 'access_token',\n\tTOKEN_TYPE = 'token_type',\n\tEXPIRES_IN = 'expires_in',\n\tUSERNAME = 'username',\n\tPASSWORD = 'password',\n\tREFRESH_TOKEN = 'refresh_token',\n\tRESPONSE_MODE = 'response_mode', // STS Extension\n\tTIMESTAMP = 'timestamp', // STS Extension\n\tTRACE_ID = 'trace_id', // STS Extension\n\tCORRELATION_ID = 'correlation_id' // STS Extension\n}\n\n// OIDC Standard Claims\n// Ref: https://openid.net/specs/openid-connect-core-1_0.html#Claims\nexport enum OIDCStandardClaim {\n\tSUB = 'sub',\n\tNAME = 'name',\n\tGIVEN_NAME = 'given_name',\n\tFAMILY_NAME = 'family_name',\n\tMIDDLE_NAME = 'middle_name',\n\tNICKNAME = 'nickname',\n\tPREFERRED_USERNAME = 'preferred_username',\n\tPROFILE = 'profile',\n\tPICTURE = 'picture',\n\tWEBSITE = 'website',\n\tEMAIL = 'email',\n\tEMAIL_VERIFIED = 'email_verified',\n\tGENDER = 'gender',\n\tBIRTHDATE = 'birthdate',\n\tZONEINFO = 'zoneinfo',\n\tLOCALE = 'locale',\n\tPHONE_NUMBER = 'phone_number',\n\tPHONE_NUMBER_VERIFIED = 'phone_number_verified',\n\tADDRESS = 'address',\n\tCLIENT_SECRET = 'client_secret',\n\tNONCE = 'nonce' // STS Extension\n}\n\nexport enum OIDCAddressClaim {\n\tFORMATTED = 'formatted',\n\tSTREET_ADDRESS = 'street_address',\n\tLOCALITY = 'locality',\n\tREGION = 'region',\n\tCOUNTRY = 'country'\n}\n\nexport class OAuth2ParameterErrorType {\n    static readonly NOT_EQUAL: errorCode = {\n        code: 'STS_OAUTH2_ERR_0001',\n        description: 'Parameter values not equal.'\n    }\n    static readonly NOT_PRESENT: errorCode = {\n        code: 'STS_OAUTH2_ERR_0002',\n        description: 'Parameter not provided.'\n    }\n    static readonly INVALID_FORMAT: errorCode = {\n        code: 'STS_OAUTH2_ERR_0003',\n        description: 'Parameter value format invalid.'\n    }\n    static readonly EXPIRED: errorCode = {\n        code: 'STS_OAUTH2_ERR_0004',\n        description: 'Parameter value expired.'\n    }\n}\n\nexport function compareParameterTypes(source1: string[], source2: string[], authParameterTypes: OAuth2ParameterType[]): errorPayload[] {\n    const errors: errorPayload[] = [ ];\n    for (let i=0 ; i < authParameterTypes.length; i++) {\n        const authParameterType = authParameterTypes[i];\n        if (source1[i].localeCompare(source2[i]) !== 0) {\n            const error: errorPayload = {\n                error: OAuth2ParameterErrorType.NOT_EQUAL.code,\n                error_description: OAuth2ParameterErrorType.NOT_EQUAL.description,\n                timestamp: Date.now(),\n                details: `${OAuth2ParameterErrorType.NOT_EQUAL.description}: Parameter: [${authParameterType}]`\n            }\n            errors.push(error);\n        }\n    }\n    return errors;\n}\n"],"names":["OAuth2ParameterType","OIDCStandardClaim","OIDCAddressClaim"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAcgB,WAAA,gBAAgB,WAAsB,UAAmB,MAAoB;AAClF,WAAA;AAAA,MACH,OAAO,UAAU;AAAA,MACjB,mBAAmB,UAAU;AAAA,MAC7B,WAAW,KAAK,IAAI;AAAA;AAAA;AAAA,MAGpB;AAAA,IAAA;AAAA,EAER;AClBA,QAAM,MAAM,IAAI;AAEhB,QAAM,YAAY,CAAC,WAAyC,YAAwC;AAC1F,UAAA,QAAiB,UAAU,OAAO;AACxC,QAAI,CAAC,OAAO;AACR,aAAO,UAAU;AAAA,IAAA,OACd;AACI,aAAA;AAAA,IACX;AAAA,EAQJ;AAEgB,WAAA,UAAU,MAAc,QAAsB;AACtD,QAAA,UAAU,QAAQ,IAAI;AAAA,EAO9B;AAEgB,WAAA,SAAS,MAAc,SAA8B;AAC3D,UAAA,YAAsD,IAAI,UAAU,IAAI;AAC9E,QAAI,WAAW;AACJ,aAAA,UAAU,WAAW,OAAO;AAAA,IACvC;AAAA,EACJ;AAAA,EClCO,MAAM,eACb;AAAA,IAGI,YAAY,UAA6B,MACzC;AAHA;AAII,yBAAK,UAAW;AAEhB,UAAI,YAAY,MAAM;AACd,YAAA,OAAO,QAAQ,cAAc;AAAa;AAAA,aAGvC;AACM,mBAAA,QAAQ,WAAqB,OAAO;AAAA,QACjD;AAAA,MACJ;AAAA,IACJ;AAAA,IAEA,IAAI,UACJ;AACI,aAAO,mBAAK;AAAA,IAChB;AAAA,EACJ;AApBI;ACNkB,iBAAA,MAAM,eAAe,KAAqB;AAC5D,WAAO,IAAI,QAAQ,CAAA,YAAW,WAAW,SAAS,YAAY,CAAC;AAAA,EACnE;AAGA,iBAAsB,YAA2B;AAC7C,WAAO,MAAM,GAAG;AAAA,EACpB;ACJY,MAAA,wCAAAA,yBAAL;AACNA,yBAAA,UAAW,IAAA;AACXA,yBAAA,WAAY,IAAA;AACZA,yBAAA,eAAgB,IAAA;AAChBA,yBAAA,eAAgB,IAAA;AAChBA,yBAAA,OAAQ,IAAA;AACRA,yBAAA,OAAQ,IAAA;AACRA,yBAAA,cAAe,IAAA;AACfA,yBAAA,OAAQ,IAAA;AACRA,yBAAA,mBAAoB,IAAA;AACpBA,yBAAA,aAAc,IAAA;AACdA,yBAAA,WAAY,IAAA;AACZA,yBAAA,YAAa,IAAA;AACbA,yBAAA,MAAO,IAAA;AACPA,yBAAA,cAAe,IAAA;AACfA,yBAAA,YAAa,IAAA;AACbA,yBAAA,YAAa,IAAA;AACbA,yBAAA,UAAW,IAAA;AACXA,yBAAA,UAAW,IAAA;AACXA,yBAAA,eAAgB,IAAA;AAChBA,yBAAA,eAAgB,IAAA;AAChBA,yBAAA,WAAY,IAAA;AACZA,yBAAA,UAAW,IAAA;AACXA,yBAAA,gBAAiB,IAAA;AAvBNA,WAAAA;AAAAA,EAAA,GAAA,uBAAA,CAAA,CAAA;AA4BA,MAAA,sCAAAC,uBAAL;AACNA,uBAAA,KAAM,IAAA;AACNA,uBAAA,MAAO,IAAA;AACPA,uBAAA,YAAa,IAAA;AACbA,uBAAA,aAAc,IAAA;AACdA,uBAAA,aAAc,IAAA;AACdA,uBAAA,UAAW,IAAA;AACXA,uBAAA,oBAAqB,IAAA;AACrBA,uBAAA,SAAU,IAAA;AACVA,uBAAA,SAAU,IAAA;AACVA,uBAAA,SAAU,IAAA;AACVA,uBAAA,OAAQ,IAAA;AACRA,uBAAA,gBAAiB,IAAA;AACjBA,uBAAA,QAAS,IAAA;AACTA,uBAAA,WAAY,IAAA;AACZA,uBAAA,UAAW,IAAA;AACXA,uBAAA,QAAS,IAAA;AACTA,uBAAA,cAAe,IAAA;AACfA,uBAAA,uBAAwB,IAAA;AACxBA,uBAAA,SAAU,IAAA;AACVA,uBAAA,eAAgB,IAAA;AAChBA,uBAAA,OAAQ,IAAA;AArBGA,WAAAA;AAAAA,EAAA,GAAA,qBAAA,CAAA,CAAA;AAwBA,MAAA,qCAAAC,sBAAL;AACNA,sBAAA,WAAY,IAAA;AACZA,sBAAA,gBAAiB,IAAA;AACjBA,sBAAA,UAAW,IAAA;AACXA,sBAAA,QAAS,IAAA;AACTA,sBAAA,SAAU,IAAA;AALCA,WAAAA;AAAAA,EAAA,GAAA,oBAAA,CAAA,CAAA;AAAA,EAQL,MAAM,yBAAyB;AAAA,EAiBtC;AAhBI,gBADS,0BACO,aAAuB;AAAA,IACnC,MAAM;AAAA,IACN,aAAa;AAAA,EAAA;AAEjB,gBALS,0BAKO,eAAyB;AAAA,IACrC,MAAM;AAAA,IACN,aAAa;AAAA,EAAA;AAEjB,gBATS,0BASO,kBAA4B;AAAA,IACxC,MAAM;AAAA,IACN,aAAa;AAAA,EAAA;AAEjB,gBAbS,0BAaO,WAAqB;AAAA,IACjC,MAAM;AAAA,IACN,aAAa;AAAA,EAAA;AAIL,WAAA,sBAAsB,SAAmB,SAAmB,oBAA2D;AACnI,UAAM,SAAyB,CAAA;AAC/B,aAAS,IAAE,GAAI,IAAI,mBAAmB,QAAQ,KAAK;AACzC,YAAA,oBAAoB,mBAAmB,CAAC;AAC1C,UAAA,QAAQ,CAAC,EAAE,cAAc,QAAQ,CAAC,CAAC,MAAM,GAAG;AAC5C,cAAM,QAAsB;AAAA,UACxB,OAAO,yBAAyB,UAAU;AAAA,UAC1C,mBAAmB,yBAAyB,UAAU;AAAA,UACtD,WAAW,KAAK,IAAI;AAAA,UACpB,SAAS,GAAG,yBAAyB,UAAU,WAAW,iBAAiB,iBAAiB;AAAA,QAAA;AAEhG,eAAO,KAAK,KAAK;AAAA,MACrB;AAAA,IACJ;AACO,WAAA;AAAA,EACX;;;;;;;;;;;;;;"}
+{"version":3,"file":"stsutils.umd.js","sources":["../src/errorhandling.ts","../src/validate.ts","../src/stsoptionsbase.ts","../src/sleep.ts","../src/oauth2terms.ts","../src/index.ts"],"sourcesContent":["export type errorCode = {\n\tcode: string\n\tdescription: string\n}\n\nexport type errorPayload = {\n\terror: string,\n\terror_description: string,\n\ttimestamp: number,\n\t//trace_id: \"255d1aef-8c98-452f-ac51-23d051240864\", //@@\n\t//correlation_id: \"fb3d2015-bc17-4bb9-bb85-30c5cf1aaaa7\", //@@\n\tdetails?: unknown\n}\n\nexport function GetErrorPayload(errorCode: errorCode, details: unknown = null): errorPayload {\n    return {\n        error: errorCode.code,\n        error_description: errorCode.description,\n        timestamp: Date.now(),\n        //trace_id: \"255d1aef-8c98-452f-ac51-23d051240864\", //@@\n        //correlation_id: \"fb3d2015-bc17-4bb9-bb85-30c5cf1aaaa7\", //@@\n        details: details\n    }\n}\n","import Ajv, { Schema } from 'ajv/dist/jtd.js'\nimport { AnyValidateFunction } from 'ajv/dist/core.js';\n\nimport { JSONObject } from './index'\n\nconst ajv = new Ajv();\n\nconst _Validate = (validator: AnyValidateFunction<unknown>, payload: JSONObject): unknown | null => {\n    const valid: boolean = validator(payload) as boolean;\n    if (!valid) {\n        return validator.errors;\n    } else {\n        return null;\n    }\n    /*\n\t\tconsole.error(validator.errors);\n\t\tconsole.trace('Invalid Schema');\n\t\tconsole.log('Payload:-');\n\t\tconsole.log(JSON.stringify(payload));\n\t\tprocess.exit(1);\n\t\t*/\n};\n\nexport function AddSchema(name: string, schema: Schema): void {\n    ajv.addSchema(schema, name);\n    /*\n\treturn (payload) => {\n\t\tconst validator = ajv.getSchema(name)\n\t\t_Validate(validator, payload)\n\t}*/\n\n}\n\nexport function Validate(name: string, payload: JSONObject): unknown {\n    const validator: AnyValidateFunction<unknown> | undefined = ajv.getSchema(name)\n    if (validator) {\n        return _Validate(validator, payload);\n    }\n}\n","import { Validate } from './validate.js'\n\nimport { JSONObject } from './index'\n\nexport class STSOptionsBase\n{\n    #options: JSONObject | null;\n\n    constructor(options: JSONObject | null = null)\n    {\n        this.#options = options;\n\n        if (options !== null) {\n            if (typeof options.validator === 'undefined') {\n                //console.log(JSON.stringify(options));\n                //console.trace(\"Options Here ------------------------------------------------------------------------------------------\")\n            } else {\n                Validate(options.validator as string, options);\n            }\n        }\n    }\n\n    get options()\n    {\n        return this.#options;\n    }\n}\n","export async function Sleep(milliseconds = 1000): Promise<void> { \n    return new Promise(resolve => setTimeout(resolve, milliseconds))\n}\n  \n// poolsleep is required to avoid JEST reporting unclosed handles during shutdown of all tests\nexport async function JestSleep(): Promise<void> {\n    return Sleep(100);\n}\n","import { errorCode, errorPayload } from './errorhandling'\n\n// Ref: https://datatracker.ietf.org/doc/html/rfc6749#appendix-A\nexport enum OAuth2ParameterType {\n\tAUDIENCE = 'AUDIENCE', // STS Extension\n\tCLIENT_ID = 'client_id',\n\tCLIENT_SECRET = 'client_secret',\n\tRESPONSE_TYPE = 'response_type',\n\tSCOPE = 'scope',\n\tSTATE = 'state',\n\tREDIRECT_URI = 'redirect_uri',\n\tERROR = 'error',\n\tERROR_DESCRIPTION = 'error_description',\n\tERROR_CODES = 'error_codes', // STS Extension\n\tERROR_URI = 'error_uri',\n\tGRANT_TYPE = 'grant_type',\n\tCODE = 'code',\n\tACCESS_TOKEN = 'access_token',\n\tTOKEN_TYPE = 'token_type',\n\tEXPIRES_IN = 'expires_in',\n\tUSERNAME = 'username',\n\tPASSWORD = 'password',\n\tREFRESH_TOKEN = 'refresh_token',\n\tRESPONSE_MODE = 'response_mode', // STS Extension\n\tTIMESTAMP = 'timestamp', // STS Extension\n\tTRACE_ID = 'trace_id', // STS Extension\n\tCORRELATION_ID = 'correlation_id' // STS Extension\n}\n\n// OIDC Standard Claims\n// Ref: https://openid.net/specs/openid-connect-core-1_0.html#Claims\nexport enum OIDCStandardClaim {\n\tSUB = 'sub',\n\tNAME = 'name',\n\tGIVEN_NAME = 'given_name',\n\tFAMILY_NAME = 'family_name',\n\tMIDDLE_NAME = 'middle_name',\n\tNICKNAME = 'nickname',\n\tPREFERRED_USERNAME = 'preferred_username',\n\tPROFILE = 'profile',\n\tPICTURE = 'picture',\n\tWEBSITE = 'website',\n\tEMAIL = 'email',\n\tEMAIL_VERIFIED = 'email_verified',\n\tGENDER = 'gender',\n\tBIRTHDATE = 'birthdate',\n\tZONEINFO = 'zoneinfo',\n\tLOCALE = 'locale',\n\tPHONE_NUMBER = 'phone_number',\n\tPHONE_NUMBER_VERIFIED = 'phone_number_verified',\n\tADDRESS = 'address',\n\tCLIENT_SECRET = 'client_secret',\n\tNONCE = 'nonce' // STS Extension\n}\n\nexport enum OIDCAddressClaim {\n\tFORMATTED = 'formatted',\n\tSTREET_ADDRESS = 'street_address',\n\tLOCALITY = 'locality',\n\tREGION = 'region',\n\tCOUNTRY = 'country'\n}\n\nexport class OAuth2ParameterErrorType {\n    static readonly NOT_EQUAL: errorCode = {\n        code: 'STS_OAUTH2_ERR_0001',\n        description: 'Parameter values not equal.'\n    }\n    static readonly NOT_PRESENT: errorCode = {\n        code: 'STS_OAUTH2_ERR_0002',\n        description: 'Parameter not provided.'\n    }\n    static readonly INVALID_FORMAT: errorCode = {\n        code: 'STS_OAUTH2_ERR_0003',\n        description: 'Parameter value format invalid.'\n    }\n    static readonly EXPIRED: errorCode = {\n        code: 'STS_OAUTH2_ERR_0004',\n        description: 'Parameter value expired.'\n    }\n}\n\nexport function compareParameterTypes(source1: string[], source2: string[], authParameterTypes: OAuth2ParameterType[]): errorPayload[] {\n    const errors: errorPayload[] = [ ];\n    for (let i=0 ; i < authParameterTypes.length; i++) {\n        const authParameterType = authParameterTypes[i];\n        if (source1[i].localeCompare(source2[i]) !== 0) {\n            const error: errorPayload = {\n                error: OAuth2ParameterErrorType.NOT_EQUAL.code,\n                error_description: OAuth2ParameterErrorType.NOT_EQUAL.description,\n                timestamp: Date.now(),\n                details: `${OAuth2ParameterErrorType.NOT_EQUAL.description}: Parameter: [${authParameterType}]`\n            }\n            errors.push(error);\n        }\n    }\n    return errors;\n}\n","/*\nexport interface JSONObject {\n    [x: string]: string | number | boolean | string[] | number[] | boolean[] | Array<JSONObject> | JSONObject | ((p: any) => any) | undefined\n}\n// This also works :-\n//interface JSONObject2 extends Record<string, string | number | string[] | Array<JSONObject2> | JSONObject2> {};\n*/\n\nexport interface JSONObject {\n    // eslint-disable-next-line  @typescript-eslint/no-explicit-any\n    [x: string]: any | JSONObject | undefined\n}\n\nexport * from './errorhandling'\nexport * from './stsoptionsbase'\nexport * from './sleep'\nexport * from './validate'\nexport * from './oauth2terms'\n\nexport enum ModelDelimeter {\n\tROOT = '_',\n\tSEPERATOR = '|',\n\tCOMPONENT_SEPERATOR = '@',\n\tNID_SEPERATOR = '^' // This seperator splits the static and dynamic part of a context string (nid). Used for creating payload header for size optimisation.\n}\n\nexport const CheckValidChar = (checkParams: string[][]): void => {\n    const invalidChars = [ \n        ModelDelimeter.ROOT, \n        ModelDelimeter.SEPERATOR, \n        ModelDelimeter.COMPONENT_SEPERATOR, \n        ModelDelimeter.NID_SEPERATOR\n    ];\n\n    checkParams.forEach(param => {\n        invalidChars.forEach(char => {\n            if (param[1].includes(char)) {\n                throw new Error(`Invalid character inside [${param[0]}:${param[1]}], no [${char}] allowed`);\n            }\n        });\n    });\n}\n\n/* Below is legacy code used as a global record container. No longer required.\n// eslint-disable-next-line  @typescript-eslint/no-explicit-any\nexport const $stsgd: Record<string, any> = { };\n\nexport function $stsgdf<T>(): Record<string, T> {\n    return $stsgd as Record<string, T>;\n}\n*/\n"],"names":["OAuth2ParameterType","OIDCStandardClaim","OIDCAddressClaim","ModelDelimeter"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAcgB,WAAA,gBAAgB,WAAsB,UAAmB,MAAoB;AAClF,WAAA;AAAA,MACH,OAAO,UAAU;AAAA,MACjB,mBAAmB,UAAU;AAAA,MAC7B,WAAW,KAAK,IAAI;AAAA;AAAA;AAAA,MAGpB;AAAA,IAAA;AAAA,EAER;AClBA,QAAM,MAAM,IAAI;AAEhB,QAAM,YAAY,CAAC,WAAyC,YAAwC;AAC1F,UAAA,QAAiB,UAAU,OAAO;AACxC,QAAI,CAAC,OAAO;AACR,aAAO,UAAU;AAAA,IAAA,OACd;AACI,aAAA;AAAA,IACX;AAAA,EAQJ;AAEgB,WAAA,UAAU,MAAc,QAAsB;AACtD,QAAA,UAAU,QAAQ,IAAI;AAAA,EAO9B;AAEgB,WAAA,SAAS,MAAc,SAA8B;AAC3D,UAAA,YAAsD,IAAI,UAAU,IAAI;AAC9E,QAAI,WAAW;AACJ,aAAA,UAAU,WAAW,OAAO;AAAA,IACvC;AAAA,EACJ;AAAA,EClCO,MAAM,eACb;AAAA,IAGI,YAAY,UAA6B,MACzC;AAHA;AAII,yBAAK,UAAW;AAEhB,UAAI,YAAY,MAAM;AACd,YAAA,OAAO,QAAQ,cAAc;AAAa;AAAA,aAGvC;AACM,mBAAA,QAAQ,WAAqB,OAAO;AAAA,QACjD;AAAA,MACJ;AAAA,IACJ;AAAA,IAEA,IAAI,UACJ;AACI,aAAO,mBAAK;AAAA,IAChB;AAAA,EACJ;AApBI;ACNkB,iBAAA,MAAM,eAAe,KAAqB;AAC5D,WAAO,IAAI,QAAQ,CAAA,YAAW,WAAW,SAAS,YAAY,CAAC;AAAA,EACnE;AAGA,iBAAsB,YAA2B;AAC7C,WAAO,MAAM,GAAG;AAAA,EACpB;ACJY,MAAA,wCAAAA,yBAAL;AACNA,yBAAA,UAAW,IAAA;AACXA,yBAAA,WAAY,IAAA;AACZA,yBAAA,eAAgB,IAAA;AAChBA,yBAAA,eAAgB,IAAA;AAChBA,yBAAA,OAAQ,IAAA;AACRA,yBAAA,OAAQ,IAAA;AACRA,yBAAA,cAAe,IAAA;AACfA,yBAAA,OAAQ,IAAA;AACRA,yBAAA,mBAAoB,IAAA;AACpBA,yBAAA,aAAc,IAAA;AACdA,yBAAA,WAAY,IAAA;AACZA,yBAAA,YAAa,IAAA;AACbA,yBAAA,MAAO,IAAA;AACPA,yBAAA,cAAe,IAAA;AACfA,yBAAA,YAAa,IAAA;AACbA,yBAAA,YAAa,IAAA;AACbA,yBAAA,UAAW,IAAA;AACXA,yBAAA,UAAW,IAAA;AACXA,yBAAA,eAAgB,IAAA;AAChBA,yBAAA,eAAgB,IAAA;AAChBA,yBAAA,WAAY,IAAA;AACZA,yBAAA,UAAW,IAAA;AACXA,yBAAA,gBAAiB,IAAA;AAvBNA,WAAAA;AAAAA,EAAA,GAAA,uBAAA,CAAA,CAAA;AA4BA,MAAA,sCAAAC,uBAAL;AACNA,uBAAA,KAAM,IAAA;AACNA,uBAAA,MAAO,IAAA;AACPA,uBAAA,YAAa,IAAA;AACbA,uBAAA,aAAc,IAAA;AACdA,uBAAA,aAAc,IAAA;AACdA,uBAAA,UAAW,IAAA;AACXA,uBAAA,oBAAqB,IAAA;AACrBA,uBAAA,SAAU,IAAA;AACVA,uBAAA,SAAU,IAAA;AACVA,uBAAA,SAAU,IAAA;AACVA,uBAAA,OAAQ,IAAA;AACRA,uBAAA,gBAAiB,IAAA;AACjBA,uBAAA,QAAS,IAAA;AACTA,uBAAA,WAAY,IAAA;AACZA,uBAAA,UAAW,IAAA;AACXA,uBAAA,QAAS,IAAA;AACTA,uBAAA,cAAe,IAAA;AACfA,uBAAA,uBAAwB,IAAA;AACxBA,uBAAA,SAAU,IAAA;AACVA,uBAAA,eAAgB,IAAA;AAChBA,uBAAA,OAAQ,IAAA;AArBGA,WAAAA;AAAAA,EAAA,GAAA,qBAAA,CAAA,CAAA;AAwBA,MAAA,qCAAAC,sBAAL;AACNA,sBAAA,WAAY,IAAA;AACZA,sBAAA,gBAAiB,IAAA;AACjBA,sBAAA,UAAW,IAAA;AACXA,sBAAA,QAAS,IAAA;AACTA,sBAAA,SAAU,IAAA;AALCA,WAAAA;AAAAA,EAAA,GAAA,oBAAA,CAAA,CAAA;AAAA,EAQL,MAAM,yBAAyB;AAAA,EAiBtC;AAhBI,gBADS,0BACO,aAAuB;AAAA,IACnC,MAAM;AAAA,IACN,aAAa;AAAA,EAAA;AAEjB,gBALS,0BAKO,eAAyB;AAAA,IACrC,MAAM;AAAA,IACN,aAAa;AAAA,EAAA;AAEjB,gBATS,0BASO,kBAA4B;AAAA,IACxC,MAAM;AAAA,IACN,aAAa;AAAA,EAAA;AAEjB,gBAbS,0BAaO,WAAqB;AAAA,IACjC,MAAM;AAAA,IACN,aAAa;AAAA,EAAA;AAIL,WAAA,sBAAsB,SAAmB,SAAmB,oBAA2D;AACnI,UAAM,SAAyB,CAAA;AAC/B,aAAS,IAAE,GAAI,IAAI,mBAAmB,QAAQ,KAAK;AACzC,YAAA,oBAAoB,mBAAmB,CAAC;AAC1C,UAAA,QAAQ,CAAC,EAAE,cAAc,QAAQ,CAAC,CAAC,MAAM,GAAG;AAC5C,cAAM,QAAsB;AAAA,UACxB,OAAO,yBAAyB,UAAU;AAAA,UAC1C,mBAAmB,yBAAyB,UAAU;AAAA,UACtD,WAAW,KAAK,IAAI;AAAA,UACpB,SAAS,GAAG,yBAAyB,UAAU,WAAW,iBAAiB,iBAAiB;AAAA,QAAA;AAEhG,eAAO,KAAK,KAAK;AAAA,MACrB;AAAA,IACJ;AACO,WAAA;AAAA,EACX;AC9EY,MAAA,mCAAAC,oBAAL;AACNA,oBAAA,MAAO,IAAA;AACPA,oBAAA,WAAY,IAAA;AACZA,oBAAA,qBAAsB,IAAA;AACtBA,oBAAA,eAAgB,IAAA;AAJLA,WAAAA;AAAAA,EAAA,GAAA,kBAAA,CAAA,CAAA;AAOC,QAAA,iBAAiB,CAAC,gBAAkC;AAC7D,UAAM,eAAe;AAAA,MACjB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA;AAAA,IAAA;AAGJ,gBAAY,QAAQ,CAAS,UAAA;AACzB,mBAAa,QAAQ,CAAQ,SAAA;AACzB,YAAI,MAAM,CAAC,EAAE,SAAS,IAAI,GAAG;AACzB,gBAAM,IAAI,MAAM,6BAA6B,MAAM,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,UAAU,IAAI,WAAW;AAAA,QAC9F;AAAA,MAAA,CACH;AAAA,IAAA,CACJ;AAAA,EACL;;;;;;;;;;;;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nsshunt/stsutils",
-  "version": "1.16.9",
+  "version": "1.16.11",
   "description": "",
   "main": "./dist/stsutils.umd.js",
   "module": "./dist/stsutils.mjs",
@@ -39,16 +39,16 @@
     "build2": "tsc"
   },
   "devDependencies": {
-    "@tsconfig/node20": "^20.1.0",
-    "@types/debug": "^4.1.8",
-    "@types/node": "^20.4.6",
-    "@typescript-eslint/eslint-plugin": "^6.2.1",
-    "@typescript-eslint/parser": "^6.2.1",
-    "eslint": "^8.46.0",
+    "@tsconfig/node20": "^20.1.2",
+    "@types/debug": "^4.1.9",
+    "@types/node": "^20.7.1",
+    "@typescript-eslint/eslint-plugin": "^6.7.3",
+    "@typescript-eslint/parser": "^6.7.3",
+    "eslint": "^8.50.0",
     "rollup-plugin-visualizer": "^5.9.2",
-    "typescript": "^5.1.6",
-    "vite": "^4.4.8",
-    "vitest": "^0.34.1"
+    "typescript": "^5.2.2",
+    "vite": "^4.4.9",
+    "vitest": "^0.34.5"
   },
   "dependencies": {
     "ajv": "^8.12.0"

package/types/index.d.ts

@@ -6,4 +6,11 @@ export * from './stsoptionsbase';
 export * from './sleep';
 export * from './validate';
 export * from './oauth2terms';
+export declare enum ModelDelimeter {
+    ROOT = "_",
+    SEPERATOR = "|",
+    COMPONENT_SEPERATOR = "@",
+    NID_SEPERATOR = "^"
+}
+export declare const CheckValidChar: (checkParams: string[][]) => void;
 //# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,MAAM,WAAW,UAAU;IAEvB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,GAAG,UAAU,GAAG,SAAS,CAAA;CAC5C;AAED,cAAc,iBAAiB,CAAA;AAC/B,cAAc,kBAAkB,CAAA;AAChC,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,MAAM,WAAW,UAAU;IAEvB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,GAAG,UAAU,GAAG,SAAS,CAAA;CAC5C;AAED,cAAc,iBAAiB,CAAA;AAC/B,cAAc,kBAAkB,CAAA;AAChC,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAE7B,oBAAY,cAAc;IACzB,IAAI,MAAM;IACV,SAAS,MAAM;IACf,mBAAmB,MAAM;IACzB,aAAa,MAAM;CACnB;AAED,eAAO,MAAM,cAAc,gBAAiB,MAAM,EAAE,EAAE,KAAG,IAexD,CAAA"}