@kinotic-ai/core 1.5.0 → 1.6.0

package/dist/index.cjs

@@ -74,7 +74,6 @@ __export(exports_src, {
   Scope: () => Scope,
   Publish: () => Publish,
   ParticipantConstants: () => ParticipantConstants,
-  Participant: () => Participant,
   Pageable: () => Pageable,
   Order: () => Order,
   OffsetPageable: () => OffsetPageable,
@@ -994,7 +993,7 @@ var import_operators2 = require("rxjs/operators");
 // packages/core/package.json
 var package_default = {
   name: "@kinotic-ai/core",
-  version: "1.5.0",
+  version: "1.6.0",
   type: "module",
   files: [
     "dist"
@@ -1477,23 +1476,6 @@ class ConnectedInfo {
   replyToId;
   participant;
 }
-// packages/core/src/api/security/Participant.ts
-class Participant {
-  id;
-  tenantId;
-  authScopeType;
-  authScopeId;
-  metadata;
-  roles;
-  constructor(id, tenantId, authScopeType, authScopeId, metadata, roles) {
-    this.id = id;
-    this.tenantId = tenantId;
-    this.authScopeType = authScopeType;
-    this.authScopeId = authScopeId;
-    this.metadata = metadata || new Map;
-    this.roles = roles || [];
-  }
-}
 // packages/core/src/api/security/ParticipantConstants.ts
 class ParticipantConstants {
   static PARTICIPANT_TYPE_METADATA_KEY = "type";

package/dist/index.d.cts

@@ -72,59 +72,37 @@ interface Identifiable<T> {
 	id: T | null;
 }
 /**
+* Identifying information about a logged-in participant on the RPC layer.
+*
+* This is the base shape every participant shares, regardless of scope, and is what RPC-only
+* consumers work with directly. The Kinotic OS contract layers scope-typed participants on top
+* of it — see the participant types in {@code @kinotic-ai/os-api}.
+*
+* Mirrors the server {@code org.kinotic.core.api.security.Participant}.
+*
 * Created by Navíd Mitchell 🤪on 6/16/23.
 */
 interface IParticipant extends Identifiable<string> {
 	/**
-	* The identity of the participant
-	*
-	* @return the identity of the participant
+	* The identity of the participant.
 	*/
 	id: string;
 	/**
-	* The tenant that the participant belongs to
-	*
-	* @return the tenant or null if not using multi-tenancy
+	* Key/value pairs carrying additional information about the participant.
 	*/
-	tenantId?: string | null;
+	metadata: Record<string, string>;
 	/**
-	* The scope layer this participant authenticated against.
-	* Well-known values are "SYSTEM", "ORGANIZATION", and "APPLICATION",
-	* but custom values are allowed for extensibility.
-	*/
-	authScopeType?: string | null;
-	/**
-	* The identifier of the specific scope this participant belongs to.
-	* For example, "kinotic" for system scope, an organization ID, or an application ID.
-	* Together with {@link authScopeType}, uniquely identifies which user pool
-	* this participant was authenticated from.
-	*/
-	authScopeId?: string | null;
-	/**
-	* Metadata is a map of key value pairs that can be used to store additional information about a participant
-	*
-	* @return a map of key value pairs
-	*/
-	metadata: Map<string, string>;
-	/**
-	* Roles are a list of strings that can be used to authorize a participant to perform certain actions
-	*
-	* @return a list of roles
+	* Roles used to authorize the participant to perform actions.
 	*/
 	roles: string[];
 }
 /**
+* A logged-in participant on the RPC layer. Alias of {@link IParticipant}; the Kinotic OS contract
+* ({@code @kinotic-ai/os-api}) narrows this to scope-typed participants.
+*
 * Created by Navid Mitchell on 6/2/20
 */
-declare class Participant implements IParticipant {
-	id: string;
-	tenantId?: string | null;
-	authScopeType?: string | null;
-	authScopeId?: string | null;
-	metadata: Map<string, string>;
-	roles: string[];
-	constructor(id: string, tenantId?: string, authScopeType?: string, authScopeId?: string, metadata?: Map<string, string>, roles?: string[]);
-}
+type Participant = IParticipant;
 /**
 * Contains information about the connection that was established
 */

package/dist/index.d.ts

@@ -72,59 +72,37 @@ interface Identifiable<T> {
 	id: T | null;
 }
 /**
+* Identifying information about a logged-in participant on the RPC layer.
+*
+* This is the base shape every participant shares, regardless of scope, and is what RPC-only
+* consumers work with directly. The Kinotic OS contract layers scope-typed participants on top
+* of it — see the participant types in {@code @kinotic-ai/os-api}.
+*
+* Mirrors the server {@code org.kinotic.core.api.security.Participant}.
+*
 * Created by Navíd Mitchell 🤪on 6/16/23.
 */
 interface IParticipant extends Identifiable<string> {
 	/**
-	* The identity of the participant
-	*
-	* @return the identity of the participant
+	* The identity of the participant.
 	*/
 	id: string;
 	/**
-	* The tenant that the participant belongs to
-	*
-	* @return the tenant or null if not using multi-tenancy
+	* Key/value pairs carrying additional information about the participant.
 	*/
-	tenantId?: string | null;
+	metadata: Record<string, string>;
 	/**
-	* The scope layer this participant authenticated against.
-	* Well-known values are "SYSTEM", "ORGANIZATION", and "APPLICATION",
-	* but custom values are allowed for extensibility.
-	*/
-	authScopeType?: string | null;
-	/**
-	* The identifier of the specific scope this participant belongs to.
-	* For example, "kinotic" for system scope, an organization ID, or an application ID.
-	* Together with {@link authScopeType}, uniquely identifies which user pool
-	* this participant was authenticated from.
-	*/
-	authScopeId?: string | null;
-	/**
-	* Metadata is a map of key value pairs that can be used to store additional information about a participant
-	*
-	* @return a map of key value pairs
-	*/
-	metadata: Map<string, string>;
-	/**
-	* Roles are a list of strings that can be used to authorize a participant to perform certain actions
-	*
-	* @return a list of roles
+	* Roles used to authorize the participant to perform actions.
 	*/
 	roles: string[];
 }
 /**
+* A logged-in participant on the RPC layer. Alias of {@link IParticipant}; the Kinotic OS contract
+* ({@code @kinotic-ai/os-api}) narrows this to scope-typed participants.
+*
 * Created by Navid Mitchell on 6/2/20
 */
-declare class Participant implements IParticipant {
-	id: string;
-	tenantId?: string | null;
-	authScopeType?: string | null;
-	authScopeId?: string | null;
-	metadata: Map<string, string>;
-	roles: string[];
-	constructor(id: string, tenantId?: string, authScopeType?: string, authScopeId?: string, metadata?: Map<string, string>, roles?: string[]);
-}
+type Participant = IParticipant;
 /**
 * Contains information about the connection that was established
 */

package/dist/index.js

@@ -898,7 +898,7 @@ import { first, map as map2 } from "rxjs/operators";
 // packages/core/package.json
 var package_default = {
   name: "@kinotic-ai/core",
-  version: "1.5.0",
+  version: "1.6.0",
   type: "module",
   files: [
     "dist"
@@ -1381,23 +1381,6 @@ class ConnectedInfo {
   replyToId;
   participant;
 }
-// packages/core/src/api/security/Participant.ts
-class Participant {
-  id;
-  tenantId;
-  authScopeType;
-  authScopeId;
-  metadata;
-  roles;
-  constructor(id, tenantId, authScopeType, authScopeId, metadata, roles) {
-    this.id = id;
-    this.tenantId = tenantId;
-    this.authScopeType = authScopeType;
-    this.authScopeId = authScopeId;
-    this.metadata = metadata || new Map;
-    this.roles = roles || [];
-  }
-}
 // packages/core/src/api/security/ParticipantConstants.ts
 class ParticipantConstants {
   static PARTICIPANT_TYPE_METADATA_KEY = "type";
@@ -1418,7 +1401,6 @@ export {
   Scope,
   Publish,
   ParticipantConstants,
-  Participant,
   Pageable,
   Order,
   OffsetPageable,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kinotic-ai/core",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "type": "module",
   "files": [
     "dist"