@magda/connector-sdk 1.2.1 → 2.0.0-alpha.1

package/dist/index-web.js

@@ -33242,19 +33242,19 @@ exports.default = createServiceError;
 /* 201 */
 /***/ (function(module) {
 
-module.exports = JSON.parse("{\"$schema\":\"http://json-schema.org/hyper-schema#\",\"title\":\"The distributions of a dataset\",\"description\":\"Specifies the list of distributions of a dataset.\",\"type\":\"object\",\"properties\":{\"distributions\":{\"title\":\"The distributions of this dataset.\",\"type\":\"array\",\"items\":{\"title\":\"A ID of a distribution of this dataset.\",\"type\":\"string\",\"links\":[{\"href\":\"/api/v0/registry/records/{$}\",\"rel\":\"item\"}]}}}}");
+module.exports = JSON.parse("{\"$schema\":\"http://json-schema.org/hyper-schema#\",\"title\":\"Dataset Distributions Aspect\",\"description\":\"Specifies the list of distributions of a dataset.\",\"type\":\"object\",\"properties\":{\"distributions\":{\"title\":\"The distributions of this dataset.\",\"type\":\"array\",\"items\":{\"title\":\"A ID of a distribution of this dataset.\",\"type\":\"string\",\"links\":[{\"href\":\"/api/v0/registry/records/{$}\",\"rel\":\"item\"}]}}}}");
 
 /***/ }),
 /* 202 */
 /***/ (function(module) {
 
-module.exports = JSON.parse("{\"$schema\":\"http://json-schema.org/schema#\",\"title\":\"Aspect for capturing the source of a record\",\"type\":\"object\",\"properties\":{\"id\":{\"title\":\"The id of the source.\",\"type\":\"string\"},\"type\":{\"title\":\"The type of the source.\",\"type\":\"string\"},\"url\":{\"title\":\"The source URL.\",\"type\":\"string\"},\"name\":{\"title\":\"The human-friendly name of this source.\",\"type\":\"string\"},\"originalUrl\":{\"title\":\"The original source URL. Used when the crawling source is not the original source.\",\"type\":\"string\"},\"orignalName\":{\"title\":\"The original human-friendly name of this source. Used when the crawling source is not the original source.\",\"type\":\"string\"},\"extras\":{\"title\":\"Extra Metadata\",\"description\":\"Any extra metadata a connector may have. \\nThis field is auto copied from connector configData.extras.\",\"type\":\"object\"},\"problems\":{\"title\":\"Problems encountered while creating this record from the source.\",\"type\":\"array\",\"items\":{\"title\":\"A problem report.\",\"type\":\"object\",\"properties\":{\"title\":{\"title\":\"A short explanation of the problem.\",\"type\":\"string\"},\"message\":{\"title\":\"A message describing the problem.\",\"type\":\"string\"},\"additionalInfo\":{\"title\":\"Additional information about the problem.\"}}}}}}");
+module.exports = JSON.parse("{\"$schema\":\"http://json-schema.org/schema#\",\"title\":\"Source Aspect\",\"description\":\"Aspect for capturing the source of a record\",\"type\":\"object\",\"properties\":{\"id\":{\"title\":\"The id of the source.\",\"type\":\"string\"},\"type\":{\"title\":\"The type of the source.\",\"type\":\"string\"},\"url\":{\"title\":\"The source URL.\",\"type\":\"string\"},\"name\":{\"title\":\"The human-friendly name of this source.\",\"type\":\"string\"},\"originalUrl\":{\"title\":\"The original source URL. Used when the crawling source is not the original source.\",\"type\":\"string\"},\"orignalName\":{\"title\":\"The original human-friendly name of this source. Used when the crawling source is not the original source.\",\"type\":\"string\"},\"extras\":{\"title\":\"Extra Metadata\",\"description\":\"Any extra metadata a connector may have. \\nThis field is auto copied from connector configData.extras.\",\"type\":\"object\"},\"problems\":{\"title\":\"Problems encountered while creating this record from the source.\",\"type\":\"array\",\"items\":{\"title\":\"A problem report.\",\"type\":\"object\",\"properties\":{\"title\":{\"title\":\"A short explanation of the problem.\",\"type\":\"string\"},\"message\":{\"title\":\"A message describing the problem.\",\"type\":\"string\"},\"additionalInfo\":{\"title\":\"Additional information about the problem.\"}}}}}}");
 
 /***/ }),
 /* 203 */
 /***/ (function(module) {
 
-module.exports = JSON.parse("{\"$schema\":\"http://json-schema.org/hyper-schema#\",\"title\":\"Dataset publisher\",\"description\":\"Links to the publisher of a dataset.\",\"type\":\"object\",\"properties\":{\"publisher\":{\"title\":\"The ID of the record representing the organization that published this dataset.\",\"type\":\"string\",\"links\":[{\"href\":\"/api/v0/registry/records/{$}\",\"rel\":\"item\"}]}}}");
+module.exports = JSON.parse("{\"$schema\":\"http://json-schema.org/hyper-schema#\",\"title\":\"Dataset Publisher Aspect\",\"description\":\"Links to the publisher of a dataset.\",\"type\":\"object\",\"properties\":{\"publisher\":{\"title\":\"The ID of the record representing the organization that published this dataset.\",\"type\":\"string\",\"links\":[{\"href\":\"/api/v0/registry/records/{$}\",\"rel\":\"item\"}]}}}");
 
 /***/ }),
 /* 204 */

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 import http = require('http');
+import { Response as Response_2 } from 'request';
 import { default as URI_2 } from 'urijs';
 
 export declare interface AspectBuilder {
@@ -55,8 +56,9 @@ declare class AspectDefinitionsApi {
      * Get a list of all aspects
      *
      * @param xMagdaTenantId 0
+     * @param xMagdaSession Magda internal session id
      */
-    getAll(xMagdaTenantId: number): Promise<{
+    getAll(xMagdaTenantId: number, xMagdaSession?: string): Promise<{
         response: http.IncomingMessage;
         body: Array<AspectDefinition>;
     }>;
@@ -65,8 +67,9 @@ declare class AspectDefinitionsApi {
      *
      * @param xMagdaTenantId 0
      * @param id ID of the aspect to be fetched.
+     * @param xMagdaSession Magda internal session id
      */
-    getById(xMagdaTenantId: number, id: string): Promise<{
+    getById(xMagdaTenantId: number, id: string, xMagdaSession?: string): Promise<{
         response: http.IncomingMessage;
         body: AspectDefinition;
     }>;
@@ -116,6 +119,7 @@ declare class AsyncPage<T> {
 export declare class AuthorizedRegistryClient extends RegistryClient {
     protected jwt: string;
     constructor(options: AuthorizedRegistryOptions);
+    getAspectDefinition(aspectId: string): Promise<AspectDefinition>;
     putAspectDefinition(aspectDefinition: AspectDefinition, tenantId?: number): Promise<AspectDefinition | Error>;
     postHook(hook: WebHook): Promise<WebHook | Error>;
     putHook(hook: WebHook): Promise<WebHook | Error>;
@@ -644,6 +648,33 @@ declare class RecordAspectsApi {
         response: http.IncomingMessage;
         body: DeleteResult;
     }>;
+    /**
+     * Get a list of a record&#39;s aspects
+     *
+     * @param xMagdaTenantId 0
+     * @param recordId ID of the record for which to fetch aspects.
+     * @param keyword Specify the keyword to search in the all aspects&#39; aspectId &amp; data fields.
+     * @param aspectIdOnly When set to true, will respond only an array contains aspect id only.
+     * @param start The index of the first record to retrieve.
+     * @param limit The maximum number of records to receive.
+     * @param xMagdaSession Magda internal session id
+     */
+    getAspects(xMagdaTenantId: number, recordId: string, keyword?: string, aspectIdOnly?: boolean, start?: number, limit?: number, xMagdaSession?: string): Promise<{
+        response: http.IncomingMessage;
+        body: Array<any>;
+    }>;
+    /**
+     * Get the number of aspects that a record has
+     *
+     * @param xMagdaTenantId 0
+     * @param recordId ID of the record for which to fetch an aspect.
+     * @param keyword Specify the keyword to search in the all aspects&#39; aspectId &amp; data fields.
+     * @param xMagdaSession Magda internal session id
+     */
+    getAspectsCount(xMagdaTenantId: number, recordId: string, keyword?: string, xMagdaSession?: string): Promise<{
+        response: http.IncomingMessage;
+        body: CountResponse;
+    }>;
     /**
      * Get a record aspect by ID
      *
@@ -812,6 +843,17 @@ declare class RecordsApi {
         response: http.IncomingMessage;
         body: Record_2;
     }>;
+    /**
+     * Get a record in full by ID
+     * Get a record with all attached aspects data by the record ID.
+     * @param id ID of the record to be fetched.
+     * @param xMagdaTenantId 0
+     * @param xMagdaSession Magda internal session id
+     */
+    getByIdInFull(id: string, xMagdaTenantId: number, xMagdaSession?: string): Promise<{
+        response: http.IncomingMessage;
+        body: Record_2;
+    }>;
     /**
      * Get a summary record by ID
      * Gets a summary record, including all the aspect ids for which this record has data.
@@ -932,9 +974,18 @@ declare class RegistryClient {
     protected tenantId: number;
     protected jwt: string | undefined;
     constructor({ baseUrl, maxRetries, secondsBetweenRetries, tenantId }: RegistryOptions);
+    toServerError(error: {
+        body: any;
+        response: Response_2;
+    }): ServerError | {
+        body: any;
+        response: Response_2;
+    };
     getRecordUrl(id: string): string;
     getAspectDefinitions(): Promise<AspectDefinition[] | Error>;
+    getAspectDefinition(aspectId: string, jwtToken?: string): Promise<AspectDefinition>;
     getRecord(id: string, aspect?: Array<string>, optionalAspect?: Array<string>, dereference?: boolean): Promise<Record_2 | Error>;
+    getRecordInFull(id: string): Promise<Record_2>;
     getRecords<I extends Record_2>(aspect?: Array<string>, optionalAspect?: Array<string>, pageToken?: string, dereference?: boolean, limit?: number, aspectQueries?: string[], aspectOrQuery?: string[], orderBy?: string, orderByDir?: string, orderNullFirst?: boolean): Promise<RecordsPage<I> | Error>;
     getRecordsPageTokens(aspect?: Array<string>, limit?: number): Promise<string[] | Error>;
 }
@@ -959,6 +1010,16 @@ declare interface ReportProblem {
     (title: string, message?: string, additionalInfo?: any): void;
 }
 
+declare class ServerError extends Error {
+    statusCode: number;
+    constructor(message?: string, statusCode?: number);
+    toData(): {
+        isError: boolean;
+        errorCode: number;
+        errorMessage: string;
+    };
+}
+
 export declare const TenantConsts: any;
 
 declare class WebHook {
@@ -975,6 +1036,11 @@ declare class WebHook {
     'retryCount': number;
     'isRunning': any;
     'isProcessing': any;
+    'ownerId': string;
+    'creatorId': string;
+    'editorId': string;
+    'createTime': Date;
+    'editTime': Date;
 }
 
 /**