@vidispine/api 23.4.0-pre.3 → 23.4.0

package/dist/index.d.ts

@@ -174,6 +174,9 @@ import type { VXAListDocument } from '@vidispine/types';
 import type { WaveformDataDocument } from '@vidispine/types';
 import type { WebsocketUpdateRequestDocument } from '@vidispine/types';
 
+/**
+ * @namespace
+ */
 export declare const AnalyzePreset: {
     /**
      * List Analyze Preset All Presets
@@ -262,6 +265,9 @@ export declare const AnalyzePreset: {
     }) => Promise<AxiosResponse<AnalyzePresetDocument>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Api: {
     /**
      * Root API
@@ -279,6 +285,9 @@ export declare const Api: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const ApiInit: {
     /**
      * Init Api Init
@@ -296,6 +305,9 @@ export declare const ApiInit: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const ApplicationWadl: {
     /**
      * Get Application Wadl
@@ -366,6 +378,9 @@ export declare const ApplicationWadl: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const AutoProjection: {
     /**
      * List Auto Projection Rule Names
@@ -520,8 +535,11 @@ export declare const AutoProjection: {
     }) => Promise<AxiosResponse<any>>;
 };
 
-declare type AxiosRequestHeaderConfig = AxiosRequestConfig['headers'];
+export declare type AxiosRequestHeaderConfig = AxiosRequestConfig['headers'];
 
+/**
+ * @namespace
+ */
 export declare const BulkyPut: {
     /**
      * Put Bulky Put Bulky Metadata No Auth
@@ -585,6 +603,9 @@ export declare const BulkyPut: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Callback: {
     /**
      * Cloud Callback Convert Call Back No Auth
@@ -623,6 +644,9 @@ export declare const Callback: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Collection: {
     /**
      * Delete Collections
@@ -4341,6 +4365,9 @@ export declare const Collection: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Component: {
     /**
      * List Components
@@ -5129,6 +5156,9 @@ export declare const Component: {
     }) => Promise<AxiosResponse<ShapeDocument>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Configuration: {
     /**
      * List Configurations
@@ -5720,6 +5750,9 @@ export declare const Configuration: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Conform: {
     /**
      * Post Conform
@@ -5772,6 +5805,9 @@ export declare const Conform: {
     }) => Promise<AxiosResponse<JobDocument>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Cost: {
     /**
      * Get Cost Estimate
@@ -5817,6 +5853,9 @@ export declare const Cost: {
     }) => Promise<AxiosResponse<CostEstimateDocument>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Datatype: {
     /**
      * Init Datatype
@@ -5833,6 +5872,9 @@ export declare const Datatype: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Debug: {
     /**
      * Echo Debug No Auth
@@ -5852,6 +5894,9 @@ export declare const Debug: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const DeletionLock: {
     /**
      * List Deletion Lock List
@@ -6509,6 +6554,9 @@ export declare const DeletionLock: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 declare const Document_2: {
     /**
      * List Document Instance List
@@ -7110,6 +7158,9 @@ declare const Document_2: {
 };
 export { Document_2 as Document }
 
+/**
+ * @namespace
+ */
 export declare const Eidr: {
     /**
      * Setup Eidr
@@ -7126,6 +7177,9 @@ export declare const Eidr: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 declare const Error_2: {
     /**
      * List Errors
@@ -7188,6 +7242,9 @@ declare const Error_2: {
 };
 export { Error_2 as Error }
 
+/**
+ * @namespace
+ */
 declare const Event_2: {
     /**
      * Get Event Updates Get
@@ -7369,6 +7426,9 @@ declare const Event_2: {
 };
 export { Event_2 as Event }
 
+/**
+ * @namespace
+ */
 export declare const ExportLocation: {
     /**
      * List Export Locations
@@ -7628,6 +7688,9 @@ export declare const ExportLocation: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const ExportTemplate: {
     /**
      * List Export Templates
@@ -7771,6 +7834,9 @@ export declare const ExportTemplate: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const ExternalId: {
     /**
      * List External Id Patterns
@@ -7873,6 +7939,9 @@ export declare const ExternalId: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const FieldGroup: {
     /**
      * List Collection Field Group Groups
@@ -8553,6 +8622,9 @@ export declare const FieldGroup: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 declare const File_2: {
     /**
      * List File
@@ -11810,7 +11882,7 @@ declare const File_2: {
 };
 export { File_2 as File }
 
-declare type GenericQueryParam = string | number | boolean;
+export declare type GenericQueryParam = string | number | boolean;
 
 /**
  * Get the default axios instance used in requests
@@ -11819,6 +11891,9 @@ declare type GenericQueryParam = string | number | boolean;
  */
 export declare const getAxiosInstance: () => AxiosInstance;
 
+/**
+ * @namespace
+ */
 export declare const Group: {
     /**
      * Delete Groups
@@ -12966,6 +13041,9 @@ export declare const Group: {
     }) => Promise<AxiosResponse<UserListDocument>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Import: {
     /**
      * Post Import
@@ -14052,6 +14130,9 @@ export declare const Import: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const IsOnline: {
     /**
      * Is Online No Auth
@@ -14073,6 +14154,9 @@ export declare const IsOnline: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Item: {
     /**
      * Delete Item List
@@ -18763,6 +18847,9 @@ export declare const Item: {
     }) => Promise<AxiosResponse<WaveformDataDocument>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Javascript: {
     /**
      * Get Javascript Debugging Sessions
@@ -18846,6 +18933,9 @@ export declare const Javascript: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Job: {
     /**
      * Delete Job List
@@ -19659,6 +19749,9 @@ export declare const Job: {
     }) => Promise<AxiosResponse<JobDocument>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Jobtype: {
     /**
      * List Jobtype Job Types
@@ -19678,10 +19771,13 @@ export declare const Jobtype: {
     }) => Promise<AxiosResponse<URIListDocument>>;
 };
 
-declare type KeyValueObjectQueryParam = {
+export declare type KeyValueObjectQueryParam = {
     [key: string]: SingleOrArrayGenericQueryParam;
 };
 
+/**
+ * @namespace
+ */
 export declare const Library: {
     /**
      * Delete Library Libraries
@@ -21577,6 +21673,9 @@ export declare const Library: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const License: {
     /**
      * Get License
@@ -21783,6 +21882,9 @@ export declare const License: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Log: {
     /**
      * Get Log Content
@@ -21950,6 +22052,9 @@ export declare function login({ serverUrl, token, username, password, bearerToke
  */
 export declare function logout(): void;
 
+/**
+ * @namespace
+ */
 export declare const Metadata: {
     /**
      * Get Metadata
@@ -22202,6 +22307,9 @@ export declare const Metadata: {
     }) => Promise<AxiosResponse<MetadataEntryDocument>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const MetadataField: {
     /**
      * List Metadata Fields
@@ -22830,6 +22938,9 @@ export declare const MetadataField: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Metadatarepair: {
     /**
      * Repair Metadatarepair Metadata
@@ -22846,6 +22957,9 @@ export declare const Metadatarepair: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const MetadataSchema: {
     /**
      * Delete Metadata Schema
@@ -22960,6 +23074,9 @@ export declare const MetadataSchema: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 declare const Notification_2: {
     /**
      * Delete Notifications
@@ -23162,6 +23279,9 @@ declare const Notification_2: {
 };
 export { Notification_2 as Notification }
 
+/**
+ * @namespace
+ */
 export declare const Otif: {
     /**
      * List Otif
@@ -23567,6 +23687,9 @@ export declare const Otif: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Populate: {
     /**
      * Populate Items
@@ -23622,6 +23745,9 @@ export declare const Populate: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Poster: {
     /**
      * Delete Poster Thumbnails For Item
@@ -23884,6 +24010,9 @@ export declare const Poster: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const PresetMediaconvertTemplates: {
     /**
      * Setup Preset Mediaconvert Templates Media Convert Presets
@@ -23900,6 +24029,9 @@ export declare const PresetMediaconvertTemplates: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const PresetTemplates: {
     /**
      * Setup Preset Templates Presets
@@ -23916,6 +24048,9 @@ export declare const PresetTemplates: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Projection: {
     /**
      * List Projections
@@ -24048,6 +24183,9 @@ export declare const Projection: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Quota: {
     /**
      * List Quota Rules
@@ -24670,6 +24808,9 @@ export declare const Quota: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Reindex: {
     /**
      * Get Reindexing
@@ -24722,6 +24863,9 @@ export declare const Reindex: {
     }) => Promise<AxiosResponse<ReindexRequestDocument>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Relation: {
     /**
      * Add Item Relations
@@ -24815,6 +24959,9 @@ export declare const Relation: {
     }) => Promise<AxiosResponse<ItemRelationDocument>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Resource: {
     /**
      * List Resource Types
@@ -25160,6 +25307,9 @@ export declare const Resource: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Root: {
     /**
      * Get Root Hi
@@ -25176,6 +25326,9 @@ export declare const Root: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Samples: {
     /**
      * List Samples Types
@@ -25262,6 +25415,9 @@ export declare const Samples: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const ScheduledRequest: {
     /**
      * Delete Scheduled Requests
@@ -25362,6 +25518,9 @@ export declare const ScheduledRequest: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Schema: {
     /**
      * Get Schema Latest
@@ -25433,6 +25592,9 @@ export declare const Schema: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Search: {
     /**
      * Browse Search
@@ -25815,6 +25977,9 @@ export declare const Search: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Secret: {
     /**
      * List Secrets
@@ -25942,6 +26107,9 @@ export declare const Secret: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Selftest: {
     /**
      * Get Selftest
@@ -26029,6 +26197,9 @@ export declare const Selftest: {
     }) => Promise<AxiosResponse<SelfTestDocument>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Sequence: {
     /**
      * Get Sequence Entity In Format
@@ -26155,6 +26326,9 @@ export declare const Sequence: {
  */
 export declare const setAxiosInstance: (axiosProps: CreateAxiosDefaults) => void;
 
+/**
+ * @namespace
+ */
 export declare const Shape: {
     /**
      * List File Shape List Document By Path
@@ -28344,6 +28518,9 @@ export declare const Shape: {
     }) => Promise<AxiosResponse<ShapeDocument>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const ShapeTag: {
     /**
      * List Shape Tags
@@ -28737,8 +28914,11 @@ export declare const ShapeTag: {
     }) => Promise<AxiosResponse<any>>;
 };
 
-declare type SingleOrArrayGenericQueryParam = GenericQueryParam | GenericQueryParam[];
+export declare type SingleOrArrayGenericQueryParam = GenericQueryParam | GenericQueryParam[];
 
+/**
+ * @namespace
+ */
 export declare const Site: {
     /**
      * List Sites
@@ -29175,6 +29355,9 @@ export declare const Site: {
     }) => Promise<AxiosResponse<SimpleMetadataDocument>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Stitch: {
     /**
      * Get Stitch Image No Auth
@@ -29211,6 +29394,9 @@ export declare const Stitch: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 declare const Storage_2: {
     /**
      * List Storages
@@ -38309,6 +38495,9 @@ declare const Storage_2: {
 };
 export { Storage_2 as Storage }
 
+/**
+ * @namespace
+ */
 export declare const StorageRule: {
     /**
      * Get Storage Rules
@@ -38335,6 +38524,9 @@ export declare const StorageRule: {
     }) => Promise<AxiosResponse<StorageRulesDocument>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const SystemStatus: {
     /**
      * Get System Status
@@ -38352,6 +38544,9 @@ export declare const SystemStatus: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const TaskDefinition: {
     /**
      * List Task Definitions
@@ -39052,6 +39247,9 @@ export declare const TaskDefinition: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const TaskGroup: {
     /**
      * Delete Task Group Groups
@@ -39337,6 +39535,9 @@ export declare const TaskGroup: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Thumbnail: {
     /**
      * Delete Thumbnails For Item
@@ -39601,6 +39802,9 @@ export declare const Thumbnail: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const ThumbnailPut: {
     /**
      * Put Thumbnail Put Image No Auth
@@ -39624,6 +39828,9 @@ export declare const ThumbnailPut: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Token: {
     /**
      * Get Token String
@@ -39650,6 +39857,9 @@ export declare const Token: {
     }) => Promise<AxiosResponse<AuthenticationTokenDocument>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Transcode: {
     /**
      * Post Transcode
@@ -39680,6 +39890,9 @@ export declare const Transcode: {
     }) => Promise<AxiosResponse<JobDocument>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const TranscoderValidate: {
     /**
      * Get Transcoder Validate Validation
@@ -39704,6 +39917,9 @@ export declare const TranscoderValidate: {
     }) => Promise<AxiosResponse<TranscoderLicenseStatusDocument>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Transfer: {
     /**
      * List All Transfers
@@ -39778,6 +39994,9 @@ export declare const Transfer: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Transfertest: {
     /**
      * Post Transfertest Transfer
@@ -39809,6 +40028,9 @@ export declare const Transfertest: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const User: {
     /**
      * List Users
@@ -40854,6 +41076,9 @@ export declare const User: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Usercacherepair: {
     /**
      * Repair Usercacherepair User Cache
@@ -40875,6 +41100,9 @@ export declare const Usercacherepair: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Version: {
     /**
      * Get Version
@@ -40894,7 +41122,7 @@ export declare const Version: {
     }) => Promise<AxiosResponse<VersionDocument>>;
 };
 
-declare type VidiCoreRequestHeaderConfig = {
+export declare type VidiCoreRequestHeaderConfig = {
     username?: string;
     password?: string;
     token?: string;
@@ -40903,6 +41131,15 @@ declare type VidiCoreRequestHeaderConfig = {
     accept?: string;
 } & AxiosRequestHeaderConfig;
 
+export declare interface VidiCoreRequestProps extends Omit<AxiosRequestConfig, 'headers' | 'params'> {
+    headers?: VidiCoreRequestHeaderConfig;
+    queryParams?: object;
+    axiosInstance?: AxiosInstance;
+}
+
+/**
+ * @namespace
+ */
 export declare const VidispineLogs: {
     /**
      * Get Vidispine Logs Log And Messages
@@ -41136,6 +41373,9 @@ export declare const VidispineLogs: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const VidispineService: {
     /**
      * List Vidispine Service Services
@@ -41272,6 +41512,9 @@ export declare const VidispineService: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Vsaconnect: {
     /**
      * Configure Vsaconnect Atmosphere Resource
@@ -41306,6 +41549,9 @@ export declare const Vsaconnect: {
     }) => Promise<AxiosResponse<any>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Vxa: {
     /**
      * List Vxa VXA Node Resources
@@ -41416,6 +41662,9 @@ export declare const Vxa: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Waveform: {
     /**
      * Get Waveform Image No Auth
@@ -41438,6 +41687,9 @@ export declare const Waveform: {
     }) => Promise<AxiosResponse<string>>;
 };
 
+/**
+ * @namespace
+ */
 export declare const Whoami: {
     /**
      * Whoami

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vidispine/api",
-  "version": "23.4.0-pre.3",
+  "version": "23.4.0",
   "license": "SEE LICENSE IN LICENSE.md",
   "publishConfig": {
     "access": "public",
@@ -29,33 +29,33 @@
   "scripts": {
     "build": "yarn vite build",
     "build:watch": "yarn vite build --watch --mode development",
-    "build:docs": "yarn typedoc --out ../../docs/build/api",
-    "update:docs": "yarn typedoc --logLevel Error && echo \"api docs updated\"",
+    "build:docs": "yarn typedoc --plugin typedoc-plugin-missing-exports --internalModule Internal --out ../../docs/build/api",
+    "update:docs": "yarn typedoc --plugin typedoc-plugin-missing-exports --internalModule Internal --logLevel Error && echo \"api docs updated\"",
     "start:docs": "rimraf build/docs && yarn update:docs && yarn vite serve -c vite.docs.config",
     "type-check": "tsc --noEmit --emitDeclarationOnly false",
-    "typedoc-check": "yarn typedoc --emit none --treatWarningsAsErrors --validation.invalidLink true --validation.notExported true --validation.notDocumented true",
+    "typedoc-check": "yarn typedoc --emit none --treatWarningsAsErrors --validation.invalidLink true --validation.notExported true --validation.notDocumented false",
     "lint": "yarn type-check && eslint . --cache --max-warnings=0 --ext .js,.jsx,.ts,.tsx,.md,.mdx",
     "format": "prettier . --check"
   },
   "dependencies": {
-    "@vidispine/types": "23.4.0-pre.3"
+    "@vidispine/types": "23.4.0"
   },
   "peerDependencies": {
     "axios": "^1.1.3",
     "buffer": "^6.0.0"
   },
   "devDependencies": {
-    "@vidispine/eslint-config-base": "23.4.0-pre.3",
-    "@vidispine/eslint-config-mdx": "23.4.0-pre.3",
-    "@vidispine/eslint-config-storybook": "23.4.0-pre.3",
-    "@vidispine/tests": "23.4.0-pre.3",
+    "@vidispine/eslint-config-base": "23.4.0",
+    "@vidispine/eslint-config-mdx": "23.4.0",
+    "@vidispine/eslint-config-storybook": "23.4.0",
+    "@vidispine/tests": "23.4.0",
     "axios": "1.6.2",
     "buffer": "6.0.3",
     "eslint": "8.55.0",
-    "prettier": "3.1.0",
+    "prettier": "3.1.1",
     "rimraf": "5.0.5",
-    "typedoc": "0.23.28",
-    "typedoc-plugin-missing-exports": "1.0.0",
+    "typedoc": "0.25.4",
+    "typedoc-plugin-missing-exports": "2.1.0",
     "typescript": "5.0.4",
     "vite": "4.5.1",
     "vite-plugin-dts": "3.6.4"