@oasisomniverse/web5-api 1.0.0

package/docs/modules/Libraries.md

@@ -0,0 +1,1052 @@
+# Libraries — `star.libraries`
+
+Source controller: [`LibrariesController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/STAR%20ODK/NextGenSoftware.OASIS.STAR.WebAPI/Controllers/LibrariesController.cs)
+Route prefix: `api/libraries`
+22 operation(s).
+
+Every method takes a single args object: any key matching a `{token}` in the route is substituted into the URL; everything else becomes the query string (GET/DELETE) or JSON body (POST/PUT). Every call resolves to the standard OASIS envelope:
+
+```ts
+{
+  isError: boolean;
+  isWarning: boolean;
+  message: string;
+  errorCode?: string;
+  result: T; // see each endpoint's Response section below
+}
+```
+
+## Operations
+
+### `activateLibrary`
+
+Activates a library.
+
+**POST** `api/libraries/{id}/activate`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body fields:
+
+| Field | Type |
+| --- | --- |
+| `version` | `int (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.activateLibrary({
+    id: '<id>',
+    version: 1
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `cloneLibrary`
+
+**POST** `api/libraries/{id}/clone`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body type: `CloneRequest`
+
+| Field | Type |
+| --- | --- |
+| `NewName` | `string` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.cloneLibrary({
+    id: '<id>',
+    newName: "example string"
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `createLibrary`
+
+Creates a new library for the authenticated avatar.
+
+**POST** `api/libraries`
+
+**Request**
+
+Body type: `CreateLibraryRequest`
+
+| Field | Type |
+| --- | --- |
+| `Name` | `string` |
+| `Description` | `string` |
+| `SourcePath` | `string` |
+| `Category` | `string` |
+| `Version` | `string` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.createLibrary({
+    name: "example string",
+    description: "example string",
+    sourcePath: "example string",
+    category: "example string",
+    version: "example string"
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `createLibraryWithOptions`
+
+Creates a new library with specified parameters.
+
+**POST** `api/libraries/create`
+
+**Request**
+
+Body type: `CreateLibraryWithOptionsRequest`
+
+| Field | Type |
+| --- | --- |
+| `Name` | `string` |
+| `Description` | `string` |
+| `HolonSubType` | `HolonType` |
+| `SourceFolderPath` | `string` |
+| `CreateOptions` | `ISTARNETCreateOptions<Library, STARNETDNA>` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.createLibraryWithOptions({
+    name: "example string",
+    description: "example string",
+    holonSubType: {  },
+    sourceFolderPath: "example string",
+    createOptions: { "STARNETHolon": /* <T1> */, "STARNETDNA": /* <T2> */, "MetaTagMappings": { "MetaHolonTags": [{ "HolonName": "example string", "HolonType": {  }, "NodeName": "example string", "NodeType": { "Score": 1.0 }, "MetaTag": "example string" }], "MetaTags": { "<string>": "example string" } }, "CheckIfSourcePathExists": true, "CustomCreateParams": { "<string>": {} } }
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `deactivateLibrary`
+
+Deactivates a library.
+
+**POST** `api/libraries/{id}/deactivate`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body fields:
+
+| Field | Type |
+| --- | --- |
+| `version` | `int (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.deactivateLibrary({
+    id: '<id>',
+    version: 1
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `deleteLibrary`
+
+**DELETE** `api/libraries/{id}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.deleteLibrary({
+    id: '<id>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `downloadLibrary`
+
+Downloads a library from the STARNET system.
+
+**POST** `api/libraries/{id}/download`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body fields:
+
+| Field | Type |
+| --- | --- |
+| `version` | `int (optional)` |
+| `downloadPath` | `string (optional)` |
+| `reInstall` | `bool (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.downloadLibrary({
+    id: '<id>',
+    version: 1,
+    downloadPath: 'example string',
+    reInstall: true
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `editLibrary`
+
+Edits a library with new DNA configuration.
+
+**POST** `api/libraries/{id}/edit`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body type: `EditLibraryRequest`
+
+| Field | Type |
+| --- | --- |
+| `NewDNA` | `STARNETDNA` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.editLibrary({
+    id: '<id>',
+    newDNA: { "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Name": "example string", "Description": "example string", "STARNETHolonType": "example string", "STARNETCategory": {}, "STARNETSubCategory": {}, "Dependencies": { "OAPPs": [{ "Type": {  }, "HolonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "STARNETHolonId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Name": "example string", "Description": "example string", "Version": "example string", "VersionSequence": 1, "Install": true, "InstallMode": {  }, "InstalledFrom": "example string", "InstalledTo": "example string" }], "Runtimes": [], "Libraries": [], "Templates": [], "NFTs": [], "NFTCollections": [], "GeoNFTs": [], "GeoNFTCollections": [], "GeoHotSpots": [], "Quests": [], "Missions": [], "Chapters": [], "InventoryItems": [], "CelestialSpaces": [], "CelestialBodies": [], "Zomes": [], "Holons": [], "CelestialBodiesMetaDataDNA": [], "ZomesMetaDataDNA": [], "HolonsMetaDataDNA": [] }, "MetaData": { "<string>": {} }, "MetaHolonTagMappings": /* <>> */, "MetaTagMappings": { "<string>": "example string" }, "CreatedByAvatarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "CreatedByAvatarUsername": "example string", "CreatedOn": "2026-01-01T00:00:00Z", "SourcePath": "example string", "PublishedPath": "example string", "PublishedByAvatarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "PublishedByAvatarUsername": "example string", "PublishedOn": "2026-01-01T00:00:00Z", "LaunchTarget": "example string", "ModifiedByAvatarId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ModifiedByAvatarUsername": "example string", "ModifiedOn": "2026-01-01T00:00:00Z", "PublishedOnSTARNET": true, "PublishedToCloud": true, "PublishedToPinata": true, "PinataIPFSHash": "example string", "PublishedProviderType": "example string", "FileSize": 1, "Version": "example string", "OASISRuntimeVersion": "example string", "OASISAPIVersion": "example string", "COSMICVersion": "example string", "STARRuntimeVersion": "example string", "STARODKVersion": "example string", "STARAPIVersion": "example string", "STARNETVersion": "example string", "DotNetVersion": "example string", "VersionSequence": 1, "Downloads": 1, "Installs": 1, "TotalDownloads": 1, "TotalInstalls": 1, "NumberOfVersions": 1 }
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `getAllLibraries`
+
+Retrieves all libraries in the system.
+
+**GET** `api/libraries`
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.getAllLibraries({});
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `getLibrariesByCategory`
+
+**GET** `api/libraries/by-category/{category}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `category` | `string` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.getLibrariesByCategory({
+    category: '<category>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `getLibrary`
+
+Retrieves a specific library by its unique identifier.
+
+**GET** `api/libraries/{id}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.getLibrary({
+    id: '<id>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `getLibraryVersions`
+
+Gets all versions of a specific library.
+
+**GET** `api/libraries/{id}/versions`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.getLibraryVersions({
+    id: '<id>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `loadAllLibrariesForAvatar`
+
+Loads all libraries for the authenticated avatar.
+
+**GET** `api/libraries/load-all-for-avatar`
+
+**Request**
+
+Query parameters:
+
+| Field | Type |
+| --- | --- |
+| `showAllVersions` | `bool (optional)` |
+| `version` | `int (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.loadAllLibrariesForAvatar({
+    showAllVersions: true,
+    version: 1
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `loadLibrary`
+
+Loads a library by ID with optional version and holon type.
+
+**GET** `api/libraries/{id}/load`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Query parameters:
+
+| Field | Type |
+| --- | --- |
+| `version` | `int (optional)` |
+| `holonType` | `string (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.loadLibrary({
+    id: '<id>',
+    version: 1,
+    holonType: 'example string'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `loadLibraryFromPath`
+
+Loads a library from source or installed folder path.
+
+**GET** `api/libraries/load-from-path`
+
+**Request**
+
+Query parameters:
+
+| Field | Type |
+| --- | --- |
+| `path` | `string` |
+| `holonType` | `string (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.loadLibraryFromPath({
+    path: 'example string',
+    holonType: 'example string'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `loadLibraryFromPublished`
+
+Loads a library from a published file.
+
+**GET** `api/libraries/load-from-published`
+
+**Request**
+
+Query parameters:
+
+| Field | Type |
+| --- | --- |
+| `publishedFilePath` | `string` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.loadLibraryFromPublished({
+    publishedFilePath: 'example string'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `loadLibraryVersion`
+
+Loads a specific version of a library.
+
+**GET** `api/libraries/{id}/version/{version}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+| `version` | `string` |
+
+**Request**
+
+No request body.
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.loadLibraryVersion({
+    id: '<id>',
+    version: '<version>'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `publishLibrary`
+
+Publishes a library to the STARNET system.
+
+**POST** `api/libraries/{id}/publish`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body type: `PublishRequest`
+
+| Field | Type |
+| --- | --- |
+| `SourcePath` | `string` |
+| `LaunchTarget` | `string` |
+| `PublishPath` | `string` |
+| `Edit` | `bool` |
+| `RegisterOnSTARNET` | `bool` |
+| `GenerateBinary` | `bool` |
+| `UploadToCloud` | `bool` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.publishLibrary({
+    id: '<id>',
+    sourcePath: "example string",
+    launchTarget: "example string",
+    publishPath: "example string",
+    edit: true,
+    registerOnSTARNET: true,
+    generateBinary: true,
+    uploadToCloud: true
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `republishLibrary`
+
+Republishes a library to the STARNET system.
+
+**POST** `api/libraries/{id}/republish`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body fields:
+
+| Field | Type |
+| --- | --- |
+| `version` | `int (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.republishLibrary({
+    id: '<id>',
+    version: 1
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `searchLibraries`
+
+**GET** `api/libraries/search`
+
+**Request**
+
+Query parameters:
+
+| Field | Type |
+| --- | --- |
+| `searchTerm` | `string` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.searchLibraries({
+    searchTerm: 'example string'
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `unpublishLibrary`
+
+Unpublishes a library from the STARNET system.
+
+**POST** `api/libraries/{id}/unpublish`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body fields:
+
+| Field | Type |
+| --- | --- |
+| `version` | `int (optional)` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.unpublishLibrary({
+    id: '<id>',
+    version: 1
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+
+---
+
+### `updateLibrary`
+
+**PUT** `api/libraries/{id}`
+
+Route parameters:
+
+| Field | Type |
+| --- | --- |
+| `id` | `Guid` |
+
+**Request**
+
+Body type: `UpdateLibraryRequest`
+
+| Field | Type |
+| --- | --- |
+| `Name` | `string?` |
+| `Description` | `string?` |
+| `Category` | `string?` |
+| `Version` | `string?` |
+
+**Response**
+
+Standard `OASISResult` envelope (see top of this page) with:
+
+`result` type: `IActionResult` (not part of the request/response payload).
+
+**Example**
+
+```js
+const { isError, message, result } = await star.libraries.updateLibrary({
+    id: '<id>',
+    name: "example string",
+    description: "example string",
+    category: "example string",
+    version: "example string"
+  });
+if (isError) throw new Error(message);
+console.log(result);
+```
+
+Example response:
+
+```json
+{
+  "isError": false,
+  "message": "",
+  "result": null
+}
+```
+