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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.d.ts +12 -0
  2. package/dist/index.js +1377 -1524
  3. package/package.json +2 -2
package/dist/index.d.ts CHANGED
@@ -843,6 +843,17 @@ declare class RecordsApi {
843
843
  response: http.IncomingMessage;
844
844
  body: Record_2;
845
845
  }>;
846
+ /**
847
+ * Get a record in full by ID
848
+ * Get a record with all attached aspects data by the record ID.
849
+ * @param id ID of the record to be fetched.
850
+ * @param xMagdaTenantId 0
851
+ * @param xMagdaSession Magda internal session id
852
+ */
853
+ getByIdInFull(id: string, xMagdaTenantId: number, xMagdaSession?: string): Promise<{
854
+ response: http.IncomingMessage;
855
+ body: Record_2;
856
+ }>;
846
857
  /**
847
858
  * Get a summary record by ID
848
859
  * Gets a summary record, including all the aspect ids for which this record has data.
@@ -974,6 +985,7 @@ declare class RegistryClient {
974
985
  getAspectDefinitions(): Promise<AspectDefinition[] | Error>;
975
986
  getAspectDefinition(aspectId: string, jwtToken?: string): Promise<AspectDefinition>;
976
987
  getRecord(id: string, aspect?: Array<string>, optionalAspect?: Array<string>, dereference?: boolean): Promise<Record_2 | Error>;
988
+ getRecordInFull(id: string): Promise<Record_2>;
977
989
  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>;
978
990
  getRecordsPageTokens(aspect?: Array<string>, limit?: number): Promise<string[] | Error>;
979
991
  }