@medplum/core 2.0.5 → 2.0.7

package/dist/types/schema.d.ts

@@ -0,0 +1,120 @@
+import { OperationOutcomeIssue, Resource } from '@medplum/fhirtypes';
+/**
+ * Returns true if the given string is a valid FHIR resource type.
+ *
+ * ```ts
+ * isResourceType('Patient'); // true
+ * isResourceType('XYZ'); // false
+ * ```
+ *
+ * Note that this depends on globalSchema, which is populated by the StructureDefinition loader.
+ *
+ * In a server context, you can load all schema definitions:
+ *
+ * ```ts
+ * import { indexStructureDefinitionBundle } from '@medplum/core';
+ * import { readJson } from '@medplum/definitions';
+ * import { Bundle } from '@medplum/fhirtypes';
+ *
+ * indexStructureDefinitionBundle(readJson('fhir/r4/profiles-resources.json') as Bundle);
+ * ```
+ *
+ * In a client context, you can load the schema definitions using MedplumClient:
+ *
+ * ```ts
+ * import { MedplumClient } from '@medplum/core';
+ *
+ * const medplum = new MedplumClient();
+ * await medplum.requestSchema('Patient');
+ * ```
+ *
+ * @param resourceType The candidate resource type string.
+ * @returns True if the resource type is a valid FHIR resource type.
+ */
+export declare function isResourceType(resourceType: string): boolean;
+/**
+ * Validates that the given string is a valid FHIR resource type.
+ * On success, silently returns void.
+ * On failure, throws an OperationOutcomeError.
+ *
+ * ```ts
+ * validateResourceType('Patient'); // nothing
+ * validateResourceType('XYZ'); // throws OperationOutcomeError
+ * ```
+ *
+ * Note that this depends on globalSchema, which is populated by the StructureDefinition loader.
+ *
+ * In a server context, you can load all schema definitions:
+ *
+ * ```ts
+ * import { indexStructureDefinitionBundle } from '@medplum/core';
+ * import { readJson } from '@medplum/definitions';
+ * import { Bundle } from '@medplum/fhirtypes';
+ *
+ * indexStructureDefinitionBundle(readJson('fhir/r4/profiles-resources.json') as Bundle);
+ * ```
+ *
+ * In a client context, you can load the schema definitions using MedplumClient:
+ *
+ * ```ts
+ * import { MedplumClient } from '@medplum/core';
+ *
+ * const medplum = new MedplumClient();
+ * await medplum.requestSchema('Patient');
+ * ```
+ *
+ * @param resourceType The candidate resource type string.
+ * @returns True if the resource type is a valid FHIR resource type.
+ */
+export declare function validateResourceType(resourceType: string): void;
+/**
+ * Validates a candidate FHIR resource object.
+ * On success, silently returns void.
+ * On failure, throws an OperationOutcomeError with issues for each violation.
+ *
+ * ```ts
+ * validateResource({ resourceType: 'Patient' }); // nothing
+ * validateResource({ resourceType: 'XYZ' }); // throws OperationOutcomeError
+ * ```
+ *
+ * Note that this depends on globalSchema, which is populated by the StructureDefinition loader.
+ *
+ * In a server context, you can load all schema definitions:
+ *
+ * ```ts
+ * import { indexStructureDefinitionBundle } from '@medplum/core';
+ * import { readJson } from '@medplum/definitions';
+ * import { Bundle } from '@medplum/fhirtypes';
+ *
+ * indexStructureDefinitionBundle(readJson('fhir/r4/profiles-resources.json') as Bundle);
+ * ```
+ *
+ * In a client context, you can load the schema definitions using MedplumClient:
+ *
+ * ```ts
+ * import { MedplumClient } from '@medplum/core';
+ *
+ * const medplum = new MedplumClient();
+ * await medplum.requestSchema('Patient');
+ * ```
+ *
+ * @param resourceType The candidate resource type string.
+ * @returns True if the resource type is a valid FHIR resource type.
+ */
+export declare function validateResource<T extends Resource>(resource: T): void;
+export declare class FhirSchemaValidator<T extends Resource> {
+    #private;
+    constructor(root: T);
+    validate(): void;
+}
+/**
+ * Recursively checks for null values in an object.
+ *
+ * Note that "null" is a special value in JSON that is not allowed in FHIR.
+ *
+ * @param value Input value of any type.
+ * @param path Path string to the value for OperationOutcome.
+ * @param issues Output list of issues.
+ */
+export declare function checkForNull(value: unknown, path: string, issues: OperationOutcomeIssue[]): void;
+export declare function createStructureIssue(expression: string, details: string): OperationOutcomeIssue;

package/dist/types/types.d.ts

@@ -1,4 +1,4 @@
-import { Bundle, ElementDefinition, SearchParameter, StructureDefinition } from '@medplum/fhirtypes';
+import { Bundle, ElementDefinition, Reference, Resource, ResourceType, SearchParameter, StructureDefinition } from '@medplum/fhirtypes';
 import { SearchParameterDetails } from './search/details';
 export interface TypedValue {
     readonly type: string;
@@ -157,17 +157,17 @@ export declare function indexSearchParameter(searchParam: SearchParameter): void
 export declare function getElementDefinitionTypeName(elementDefinition: ElementDefinition): string;
 export declare function buildTypeName(components: string[]): string;
 /**
- * Returns true if the type schema is a DomainResource.
+ * Returns true if the type schema is a non-abstract FHIR resource.
  * @param typeSchema The type schema to check.
- * @returns True if the type schema is a DomainResource.
+ * @returns True if the type schema is a non-abstract FHIR resource.
  */
-export declare function isResourceType(typeSchema: TypeSchema): boolean;
+export declare function isResourceTypeSchema(typeSchema: TypeSchema): boolean;
 /**
  * Returns an array of all resource types.
  * Note that this is based on globalSchema, and will only return resource types that are currently in memory.
  * @returns An array of all resource types.
  */
-export declare function getResourceTypes(): string[];
+export declare function getResourceTypes(): ResourceType[];
 /**
  * Returns the type schema for the resource type.
  * @param resourceType The resource type.
@@ -194,6 +194,20 @@ export declare function getPropertyDisplayName(path: string): string;
  * @returns The element definition if found.
  */
 export declare function getElementDefinition(typeName: string, propertyName: string): ElementDefinition | undefined;
+/**
+ * Typeguard to validate that an object is a FHIR resource
+ * @param value The object to check
+ * @returns True if the input is of type 'object' and contains property 'resourceType'
+ */
+export declare function isResource<T extends Resource = Resource>(value: T | Reference<T> | string | undefined | null): value is T;
+/**
+ * Typeguard to validate that an object is a FHIR resource
+ * @param value The object to check
+ * @returns True if the input is of type 'object' and contains property 'reference'
+ */
+export declare function isReference<T extends Resource>(value: T | Reference<T> | string | undefined | null): value is Reference<T> & {
+    reference: string;
+};
 /**
  * Global schema singleton.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@medplum/core",
-  "version": "2.0.5",
+  "version": "2.0.7",
   "description": "Medplum TS/JS Library",
   "author": "Medplum <hello@medplum.com>",
   "license": "Apache-2.0",

package/tsconfig.build.json

@@ -1,9 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "dist/types",
-    "noEmit": false,
-    "emitDeclarationOnly": true
-  },
-  "exclude": ["**/*.test.ts"]
-}