Prepare for release

README.md

@@ -8,10 +8,6 @@ It works both in browsers (IE10+) and on the server (NodeJS).
 
 Install from npm:
 ```sh
-# v2 is still in beta! To give it a try do:
-npm i https://github.com/smart-on-fhir/client-js
-
-# To install the current version do:
 npm i fhirclient
 ```
 
@@ -29,6 +25,41 @@ The documentation for the older (current) version is at [http://docs.smarthealth
 
 <br/>
 
+## Contributing and Development
+
+### NPM Scripts
+
+After you `cd` into to the project folder and run `npm i`, you can use npm scripts to handle any project-related task:
+
+```sh
+# run tests
+npm test
+
+# Build everything
+npm run build
+
+# Build all bundles
+npm run pack
+
+# Only build the minified bundle for production
+npm run pack:prod
+
+# Only build the pure (no polyfills included) minified bundle for production
+npm run pack:prod:pure
+
+# Only build non-minified bundle for development
+npm run pack:dev
+
+# Only build the pure (no polyfills included) bundle for development
+npm run pack:dev:pure
+
+# Only build non-minified bundle for development and rebuild on change
+npm run build:dev
+
+# Build the CommonJS modules (for Node and bundlers)
+npm run build:module
+```
+
 ## License
 Apache 2.0
 

dist/changelog.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v2.1.0
+- Added convenience wrappers for the FHIR create/update/delete operations #56
+- Added patient context aware request wrapper #57
+- Fixed a refresh issue in Firefox #58
+- Improved fake token flow #59
+- Added `getFhirVersion` and `getFhirRelease` client methods
+- Few other minor fixes and improvements
+
 ## v2.0.7
 - See http://docs.smarthealthit.org/client-js/v2.html
 

dist/lib/types.d.ts

@@ -148,23 +148,23 @@ declare namespace fhirclient {
         /**
          * The current state including options and tokenResponse
          */
-        state: object;
-        environment: object;
-        api?: object;
+        state: JsonObject;
+        environment: JsonObject;
+        api?: JsonObject;
         patient: {
             id: string;
-            api?: object;
-            read(): Promise<object>;
+            api?: JsonObject;
+            read(): Promise<JsonObject>;
         };
         encounter: {
             id: string;
-            read(): Promise<object>;
+            read(): Promise<JsonObject>;
         };
         user: {
             id: string;
             fhirUser: string;
             resourceType: string;
-            read(): Promise<object>;
+            read(): Promise<JsonObject>;
         }
 
         /**
@@ -200,6 +200,24 @@ declare namespace fhirclient {
         getAuthorizationHeader(): string|null;
         _clearState(): Promise<void>;
 
+        /**
+         * Wrapper for `client.request` implementing the FHIR resource create operation
+         * @param {Object} resource A FHIR resource to be created
+         */
+        create(resource: object): Promise<RequestResult>
+
+        /**
+         * Wrapper for `client.request` implementing the FHIR resource update operation
+         * @param {Object} resource A FHIR resource to be updated
+         */
+        update(resource: object): Promise<RequestResult>
+
+        /**
+         * Wrapper for `client.request` implementing the FHIR resource delete operation
+         * @param {String} uri Relative URI of the FHIR resource to be deleted (format: `resourceType/id`)
+         */
+        delete(uri: string): Promise<RequestResult>
+
         /**
          * Use this method to query the FHIR server
          * @param uri Either the full url, or a path that will be rooted at the FHIR baseUrl.
@@ -221,6 +239,22 @@ declare namespace fhirclient {
          * Resolves with the updated state or rejects with an error.
          */
         refresh(): Promise<object>;
+
+        /**
+         * Returns a promise that will be resolved with the fhir version as defined
+         * in the conformance statement.
+         */
+        getFhirVersion(): Promise<string>;
+
+        /**
+         * Returns a promise that will be resolved with the numeric fhir version
+         * - 2 for DSTU2
+         * - 3 for STU3
+         * - 4 for R4
+         * - 0 if the version is not known
+         */
+        getFhirRelease(): Promise<number>;
+
         byCode(observations: object|object[], property: string): object[];
         byCodes(observations: object|object[], property: string): (codes: string[]) => object[];
         units: any;
@@ -255,7 +289,7 @@ declare namespace fhirclient {
      * Describes the state that should be passed to the Client constructor.
      * Everything except `serverUrl` is optional
      */
-    declare interface ClientState {
+    interface ClientState {
         /**
          * The base URL of the Fhir server. The library should have detected it
          * at authorization time from request query params of from config options.
@@ -333,7 +367,7 @@ declare namespace fhirclient {
     /**
      * Authorization parameters that can be passed to `authorize` or `init`
      */
-    declare interface AuthorizeParams {
+    interface AuthorizeParams {
 
         /**
          * This is the URL of the service you are connecting to.
@@ -430,7 +464,7 @@ declare namespace fhirclient {
      * Additional options that can be passed to `client.request` to control its
      * behavior
      */
-    declare interface FhirOptions {
+    interface FhirOptions {
 
         /**
          * When you request a Bundle, the result will typically come back in pages
@@ -538,7 +572,7 @@ declare namespace fhirclient {
      * additional properties.
      * @see http://docs.smarthealthit.org/authorization/
      */
-    declare interface TokenResponse {
+    interface TokenResponse {
 
         /**
          * If present, this tells the app that it is being rendered within an
@@ -614,10 +648,10 @@ declare namespace fhirclient {
         /**
          * Other properties might be passed by the server
          */
-        [key?: string]: any;
+        [key: string]: any;
     }
 
-    declare interface JsonObject {
+    interface JsonObject {
         [key: string]: any
     }
 }

dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fhirclient",
-  "version": "2.0.7",
+  "version": "2.1.0",
   "description": "JavaScript client for Fast Healthcare Interoperability Resources",
   "author": "SMART Health IT <support@smarthealthit.org> (https://smarthealthit.org/)",
   "contributors": [

docs/README.md

@@ -218,7 +218,6 @@ FHIR.oauth2.ready().then(client => client.api.search({ type: "Patient" }))
 </script>
 ```
 
-
 #### NodeJS Integration
 There are no global variables to detect so you'll have to link it manually using
 the dedicated `connect(fhirJs)` method of the client:
@@ -233,41 +232,6 @@ app.get("/", async (req, res) => {
 });
 ```
 
-## Contributing and Development
-
-### NPM Scripts
-
-After you `cd` into to the project folder and run `npm i`, you can use npm scripts to handle any project-related task:
-
-```sh
-# run tests
-npm test
-
-# Build everything
-npm run build
-
-# Build all bundles
-npm run pack
-
-# Only build the minified bundle for production
-npm run pack:prod
-
-# Only build the pure (no polyfills included) minified bundle for production
-npm run pack:prod:pure
-
-# Only build non-minified bundle for development
-npm run pack:dev
-
-# Only build the pure (no polyfills included) bundle for development
-npm run pack:dev:pure
-
-# Only build non-minified bundle for development and rebuild on change
-npm run build:dev
-
-# Build the CommonJS modules (for Node and bundlers)
-npm run build:module
-```
-
 ## Debugging
 This library uses the [debug](https://www.npmjs.com/package/debug) module.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fhirclient",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "JavaScript client for Fast Healthcare Interoperability Resources",
   "author": "SMART Health IT <support@smarthealthit.org> (https://smarthealthit.org/)",
   "contributors": [

src/types.d.ts

@@ -239,6 +239,22 @@ declare namespace fhirclient {
          * Resolves with the updated state or rejects with an error.
          */
         refresh(): Promise<object>;
+
+        /**
+         * Returns a promise that will be resolved with the fhir version as defined
+         * in the conformance statement.
+         */
+        getFhirVersion(): Promise<string>;
+
+        /**
+         * Returns a promise that will be resolved with the numeric fhir version
+         * - 2 for DSTU2
+         * - 3 for STU3
+         * - 4 for R4
+         * - 0 if the version is not known
+         */
+        getFhirRelease(): Promise<number>;
+
         byCode(observations: object|object[], property: string): object[];
         byCodes(observations: object|object[], property: string): (codes: string[]) => object[];
         units: any;