@twin.org/standards-foaf 0.0.3-next.6 → 0.0.3-next.61

package/dist/types/index.d.ts

@@ -1,11 +1,11 @@
 export * from "./dataTypes/foafDataTypes.js";
-export * from "./models/IAgent.js";
-export * from "./models/IBaseObject.js";
-export * from "./models/IDocument.js";
-export * from "./models/IGroup.js";
-export * from "./models/IImage.js";
-export * from "./models/IOrganization.js";
-export * from "./models/IPerson.js";
+export * from "./models/IFoafAgent.js";
+export * from "./models/IFoafBaseObject.js";
+export * from "./models/IFoafDocument.js";
+export * from "./models/IFoafGroup.js";
+export * from "./models/IFoafImage.js";
+export * from "./models/IFoafOrganization.js";
+export * from "./models/IFoafPerson.js";
 export * from "./models/foafContexts.js";
 export * from "./models/foafContextType.js";
 export * from "./models/foafTypes.js";

package/dist/types/models/{IAgent.d.ts → IFoafAgent.d.ts}

@@ -1,14 +1,14 @@
 import type { ObjectOrArray } from "@twin.org/core";
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IJsonLdNodeObject, JsonLdObjectWithAliases } from "@twin.org/data-json-ld";
 import type { FoafContextType } from "./foafContextType.js";
 import type { FoafTypes } from "./foafTypes.js";
-import type { IBaseObject } from "./IBaseObject.js";
-import type { IDocument } from "./IDocument.js";
+import type { IFoafBaseObject } from "./IFoafBaseObject.js";
+import type { IFoafDocument } from "./IFoafDocument.js";
 /**
  * A FOAF Agent.
  * @see http://xmlns.com/foaf/0.1/
  */
-export interface IAgent extends IBaseObject {
+export interface IFoafAgent extends IFoafBaseObject {
     /**
      * The LD Context.
      */
@@ -31,20 +31,25 @@ export interface IAgent extends IBaseObject {
      * A weblog of some thing (whether person, group, company etc.).
      * @see http://xmlns.com/foaf/spec/#term_weblog
      */
-    weblog?: IDocument;
+    weblog?: IFoafDocument;
     /**
      * An OpenID for an agent.
      * @see http://xmlns.com/foaf/spec/#term_openid
      */
-    openid?: IDocument;
+    openid?: IFoafDocument;
     /**
      * A page about a topic of interest to this person.
      * @see http://xmlns.com/foaf/spec/#term_interest
      */
-    interest?: IDocument;
+    interest?: IFoafDocument;
     /**
      * A thing of interest to this person.
      * @see http://xmlns.com/foaf/spec/#term_topic_interest
      */
     topic_interest?: IJsonLdNodeObject;
 }
+/**
+ * A FOAF Agent with FOAF-prefixed aliases for non-JSON-LD keys.
+ * This allows using either prefixed aliases (e.g., "foaf:name") when defining a FOAF Agent.
+ */
+export type IFoafAgentWithAliases<T extends string = "foaf"> = JsonLdObjectWithAliases<IFoafAgent, T>;

package/dist/types/models/{IBaseObject.d.ts → IFoafBaseObject.d.ts}

@@ -1,15 +1,18 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { FoafContextType } from "./foafContextType.js";
-import type { IImage } from "./IImage.js";
+import type { IFoafImage } from "./IFoafImage.js";
 /**
  * Core FOAF Properties
  * @see http://xmlns.com/foaf/0.1/
  */
-export interface IBaseObject extends IJsonLdNodeObject {
+export interface IFoafBaseObject {
     /**
      * The LD Context.
      */
     "@context"?: FoafContextType;
+    /**
+     * The unique identifier for the FOAF object.
+     */
+    "@id"?: string;
     /**
      * A name for some thing.
      * @see http://xmlns.com/foaf/spec/#term_name
@@ -34,5 +37,5 @@ export interface IBaseObject extends IJsonLdNodeObject {
      * A depiction of some thing.
      * @see http://xmlns.com/foaf/spec/#term_depiction
      */
-    depiction?: IImage;
+    depiction?: IFoafImage;
 }

package/dist/types/models/{IDocument.d.ts → IFoafDocument.d.ts}

@@ -1,13 +1,13 @@
 import type { ObjectOrArray } from "@twin.org/core";
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IJsonLdNodeObject, JsonLdObjectWithAliases } from "@twin.org/data-json-ld";
 import type { FoafContextType } from "./foafContextType.js";
 import type { FoafTypes } from "./foafTypes.js";
-import type { IBaseObject } from "./IBaseObject.js";
+import type { IFoafBaseObject } from "./IFoafBaseObject.js";
 /**
  * A FOAF Document
  * @see http://xmlns.com/foaf/0.1/
  */
-export interface IDocument extends IBaseObject {
+export interface IFoafDocument extends IFoafBaseObject {
     /**
      * The LD Context.
      */
@@ -32,3 +32,8 @@ export interface IDocument extends IBaseObject {
      */
     sha1?: string;
 }
+/**
+ * A FOAF Document with FOAF-prefixed aliases for non-JSON-LD keys.
+ * This allows using either prefixed aliases (e.g., "foaf:name") when defining a FOAF Document.
+ */
+export type IFoafDocumentWithAliases<T extends string = "foaf"> = JsonLdObjectWithAliases<IFoafDocument, T>;

package/dist/types/models/IFoafGroup.d.ts

@@ -0,0 +1,29 @@
+import type { ObjectOrArray } from "@twin.org/core";
+import type { JsonLdObjectWithAliases } from "@twin.org/data-json-ld";
+import type { FoafContextType } from "./foafContextType.js";
+import type { FoafTypes } from "./foafTypes.js";
+import type { IFoafAgent } from "./IFoafAgent.js";
+/**
+ * A FOAF Group.
+ * @see http://xmlns.com/foaf/0.1/
+ */
+export interface IFoafGroup extends IFoafAgent {
+    /**
+     * The LD Context.
+     */
+    "@context"?: FoafContextType;
+    /**
+     * Type.
+     */
+    "@type": typeof FoafTypes.Group;
+    /**
+     * Indicates a member of a Group
+     * @see http://xmlns.com/foaf/spec/#term_member
+     */
+    member?: ObjectOrArray<IFoafAgent>;
+}
+/**
+ * A FOAF Group with FOAF-prefixed aliases for non-JSON-LD keys.
+ * This allows using either prefixed aliases (e.g., "foaf:name") when defining a FOAF Group.
+ */
+export type IFoafGroupWithAliases<T extends string = "foaf"> = JsonLdObjectWithAliases<IFoafGroup, T>;

package/dist/types/models/{IImage.d.ts → IFoafImage.d.ts}

@@ -1,12 +1,12 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IJsonLdNodeObject, JsonLdObjectWithAliases } from "@twin.org/data-json-ld";
 import type { FoafContextType } from "./foafContextType.js";
 import type { FoafTypes } from "./foafTypes.js";
-import type { IDocument } from "./IDocument.js";
+import type { IFoafDocument } from "./IFoafDocument.js";
 /**
  * A FOAF image.
  * @see http://xmlns.com/foaf/0.1/
  */
-export interface IImage extends IDocument {
+export interface IFoafImage extends IFoafDocument {
     /**
      * The LD Context.
      *
@@ -25,5 +25,10 @@ export interface IImage extends IDocument {
      * A derived thumbnail image.
      * @see http://xmlns.com/foaf/spec/#term_thumbnail
      */
-    thumbnail?: IImage;
+    thumbnail?: IFoafImage;
 }
+/**
+ * A FOAF Image with FOAF-prefixed aliases for non-JSON-LD keys.
+ * This allows using either prefixed aliases (e.g., "foaf:name") when defining a FOAF Image.
+ */
+export type IFoafImageWithAliases<T extends string = "foaf"> = JsonLdObjectWithAliases<IFoafImage, T>;

package/dist/types/models/IFoafOrganization.d.ts

@@ -0,0 +1,23 @@
+import type { JsonLdObjectWithAliases } from "@twin.org/data-json-ld";
+import type { FoafContextType } from "./foafContextType.js";
+import type { FoafTypes } from "./foafTypes.js";
+import type { IFoafAgent } from "./IFoafAgent.js";
+/**
+ * A FOAF Organization.
+ * @see http://xmlns.com/foaf/0.1/
+ */
+export interface IFoafOrganization extends IFoafAgent {
+    /**
+     * The LD Context.
+     */
+    "@context"?: FoafContextType;
+    /**
+     * Type.
+     */
+    "@type": typeof FoafTypes.Organization;
+}
+/**
+ * A FOAF Organization with FOAF-prefixed aliases for non-JSON-LD keys.
+ * This allows using either prefixed aliases (e.g., "foaf:name") when defining a FOAF Organization.
+ */
+export type IFoafOrganizationWithAliases<T extends string = "foaf"> = JsonLdObjectWithAliases<IFoafOrganization, T>;

package/dist/types/models/{IPerson.d.ts → IFoafPerson.d.ts}

@@ -1,13 +1,14 @@
 import type { ObjectOrArray } from "@twin.org/core";
+import type { JsonLdObjectWithAliases } from "@twin.org/data-json-ld";
 import type { FoafContextType } from "./foafContextType.js";
 import type { FoafTypes } from "./foafTypes.js";
-import type { IAgent } from "./IAgent.js";
-import type { IImage } from "./IImage.js";
+import type { IFoafAgent } from "./IFoafAgent.js";
+import type { IFoafImage } from "./IFoafImage.js";
 /**
  * A FOAF Person.
  * @see http://xmlns.com/foaf/0.1/
  */
-export interface IPerson extends IAgent {
+export interface IFoafPerson extends IFoafAgent {
     /**
      * The LD Context.
      */
@@ -30,15 +31,20 @@ export interface IPerson extends IAgent {
      * A person known by this person (indicating some level of reciprocated interaction between the parties).
      * @see http://xmlns.com/foaf/spec/#term_knows
      */
-    knows?: ObjectOrArray<IAgent>;
+    knows?: ObjectOrArray<IFoafAgent>;
     /**
      * An image that can be used to represent some thing.
      * @see http://xmlns.com/foaf/spec/#term_img
      */
-    img?: IImage;
+    img?: IFoafImage;
     /**
      * A short informal nickname characterizing an agent (includes login identifiers, IRC and other chat nicknames).
      * @see http://xmlns.com/foaf/spec/#term_nick
      */
     nick?: string;
 }
+/**
+ * A FOAF Person with FOAF-prefixed aliases for non-JSON-LD keys.
+ * This allows using either prefixed aliases (e.g., "foaf:name") when defining a FOAF Person.
+ */
+export type IFoafPersonWithAliases<T extends string = "foaf"> = JsonLdObjectWithAliases<IFoafPerson, T>;

package/dist/types/models/foafContextType.d.ts

@@ -1,6 +1,7 @@
+import type { SingleOccurrenceArray } from "@twin.org/core";
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
 import type { FoafContexts } from "./foafContexts.js";
 /**
  * The FOAF JSON-LD context type.
  */
-export type FoafContextType = typeof FoafContexts.ContextRoot | [typeof FoafContexts.ContextRoot] | [...IJsonLdContextDefinitionElement[], typeof FoafContexts.ContextRoot];
+export type FoafContextType = typeof FoafContexts.Context | SingleOccurrenceArray<IJsonLdContextDefinitionElement, typeof FoafContexts.Context>;

package/dist/types/models/foafContexts.d.ts

@@ -3,17 +3,23 @@
  */
 export declare const FoafContexts: {
     /**
-     * The FOAF LD Context.
+     * The canonical RDF namespace URI.
      */
-    readonly ContextRoot: "https://xmlns.com/foaf/0.1/";
+    readonly Namespace: "https://xmlns.com/foaf/0.1/";
     /**
-     * The TWIN context for FOAF.
+     * The value to use in @context.
+     * Note: Context matches Namespace (both include trailing slash) as per FOAF specification.
+     * The FOAF JSON-LD context URL format includes a trailing slash.
      */
-    readonly TwinContext: "https://schema.twindev.org/foaf/";
+    readonly Context: "https://xmlns.com/foaf/0.1/";
     /**
-     * The TWIN context redirect for JSON-LD.
+     * The JSON-LD Context URL.
      */
-    readonly ContextRedirect: "https://schema.twindev.org/foaf/types.jsonld";
+    readonly JsonLdContext: "https://schema.twindev.org/foaf/types.jsonld";
+    /**
+     * The namespace location of the hosted version of the JSON Schema.
+     */
+    readonly JsonSchemaNamespace: "https://schema.twindev.org/foaf/";
 };
 /**
  * The LD Contexts concerning FOAF.