v0.1.0 (#3)

Author: hbulens

.gitignore

@@ -5,4 +5,5 @@
 *.log
 **\node_modules
 **\wwwroot\lib\**
-dist
+dist
+.env

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Dime Software
+Copyright (c) 2024 Dime Software
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,9 +1,11 @@
 <div align="center">
-<img src="https://cdn.dimescheduler.com/dime-scheduler/Dime.Scheduler-Black.svg" height="100px" />
+<img src="https://cdn.dimescheduler.com/dime-scheduler/v2/logo.svg" height="100px" />
 </div>
 
+<br />
+
 <div align="center">
-<img src="assets/app.webp" height="300px" />
+<img src="https://cdn.dimescheduler.com/dime-scheduler/screenshots/ds-screen-8.png" height="300px" />
 </div>
 
 <p align="center">
@@ -13,57 +15,54 @@
 </p>
 
 <div align="center">
-  <img src="https://github.com/dime-scheduler/sdk-js/actions/workflows/ci.yml/badge.svg?branch=master" />
   <img src="https://img.shields.io/npm/v/dimescheduler?style=flat-square" />
-  <img src="https://img.shields.io/npm/l/dimescheduler" />
+  <img src="https://img.shields.io/npm/l/dimescheduler?style=flat-square&color=brightgreen" />
+  <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" />
 </div>
 
 
 <h1 align="center"> Dime.Scheduler SDK for JavaScript</h1>
 
-Supercharge your business by powering up Microsoft Dynamics 365 Business Central with a centralized resource and project planning solution 📅. Dime.Scheduler, with its powerful features and flexible design, has a proven track record in various industries and is trusted by dozens of resellers and thousands of people all over the world 🚀.
+Supercharge your business by powering up Microsoft Dynamics 365 Business Central with a centralized resource and project planning solution 📅. Dime.Scheduler, with its powerful features and flexible design, has a proven track record in constious industries and is trusted by dozens of resellers and thousands of people all over the world 🚀.
 
-🧑‍🏫 Want to see the SDK in action? Check out an example [here](https://stackblitz.com/edit/ds-category?file=index.js).
+Check out the [📚 docs »](https://docs.dimescheduler.com) for more info.
 
 ## Installation
 
 Use whichever package manager you prefer:
 
 ```bash
+# with npm
 npm install dimescheduler
+
+# with yarn
 yarn add dimescheduler
+
+# with bun
+bun i dimescheduler
 ```
 
 ## Example
 
-🧑‍🏫 Want to see the SDK in action? Check out an example [here](https://stackblitz.com/edit/ds-category?file=index.js).
-
-```javascript
-import { DimeSchedulerClient, FormsAuthenticator, Import } from 'dimescheduler';
+The sample below shows how to insert or update a category, which is a visual indicator that is used to render the background colors of appointments on the planning board. All you need to do is:
+- Import the Dime.Scheduler client class
+- Import and instantiate the model classes
+- Instantiate the client class with the API key, and optionally, the environment
+- Invoke the import method to enter this object into Dime.Scheduler
 
-var uri = 'https://my-dimescheduler.uri';
-var user = '[email protected]';
-var pw = "mypassword";
 
-var authn = new FormsAuthenticator(uri, user, pw);
-var client = new DimeSchedulerClient(uri, authn);
+```javascript
+import DimeSchedulerClient from 'dimescheduler';
+import { Category } from "dimescheduler/models";
 
-var category = new Import.Category();
-category.name = "New category";
-category.color = '#000000';
+const category = new Category();
+category.color = '#' + (Math.random() * 0xFFFFFF << 0).toString(16);
+category.name = "My category";
 
-client.import
-  .processAsync(category)
-  .then((res) => {    
-    console.log(res.data.Success? 'Success!' : "Oh oh, something didn't quite go well.";);
-  })
-  .catch((err) => console.log('Something went wrong: ' + err.toString()));
+const dimeSchedulerClient = new DimeSchedulerClient(apiKey);
+const response = await dimeSchedulerClient.import(category);
 ```
 
-## Read more
-
-Check out the [📚 docs »](https://sdk.dimescheduler.com) for more info.
-
 ## Contributing
 
 ![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)
@@ -74,9 +73,4 @@ Pull requests are welcome. Please check out the contribution and code of conduct
 
 ![MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg?style=flat-square)
 
-Copyright © Dime CVBA - All rights reserved.
-
-Unauthorized copying of this file, via any medium is strictly prohibited Proprietary and confidential.
-
-Written by Hendrik Bulens [email protected], March 2022.
 

package.json

@@ -1,17 +1,27 @@
 {
   "name": "dimescheduler",
   "description": "The Dime.Scheduler SDK",
-  "version": "0.0.1-alpha.17",
+  "version": "0.1.0",
   "main": "./dist/index.ts",
   "types": "./dist/index.d.ts",
   "module": "./dist/esm/index.js",
   "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./models": {
+      "types": "./dist/lib/models/index.d.ts",
+      "default": "./dist/lib/models/index.js"
+    }
+  },
   "files": [
     "dist",
     "LICENSE",
     "README.md"
   ],
-  "repository": "https://github.com/dime-scheduler/sdk-nodejs",
+  "repository": "https://github.com/dime-scheduler/sdk-js",
   "author": "Hendrik Bulens",
   "license": "MIT",
   "keywords": [
@@ -22,14 +32,14 @@
     "power-apps"
   ],
   "scripts": {
-    "build": "yarn build:esm && yarn build:cjs",
-    "build:esm": "tsc",
-    "build:cjs": "tsc --module commonjs --outDir dist/cjs",
+    "build": "tsc",
     "clean": "tsc --build --clean",
+    "pub": "yarn clean && yarn build && yarn publish",
     "test": "ts-mocha test/**/*.ts --timeout 10000"
   },
   "dependencies": {
-    "axios": "^0.27.2"
+    "axios": "^0.27.2",
+    "reflect-metadata": "^0.2.2"
   },
   "devDependencies": {
     "@tsconfig/recommended": "^1.0.1",
@@ -41,4 +51,4 @@
     "ts-node": "^10.9.1",
     "typescript": "^4.7.4"
   }
-}
+}

samples/update-resource-location/.eslintrc.cjs

@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:react-hooks/recommended',
+  ],
+  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['react-refresh'],
+  rules: {
+    'react-refresh/only-export-components': [
+      'warn',
+      { allowConstantExport: true },
+    ],
+  },
+}

samples/update-resource-location/.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

samples/update-resource-location/README.md

@@ -0,0 +1,40 @@
+# Dime.Scheduler SDK for JavaScript sample: Update location
+
+## Getting started
+
+To run the project, run the following commands:
+
+```cmd
+bun install
+bun dev
+```
+
+Create an `.env` file with the Mapbox and Dime.Scheduler API keys:
+
+```
+VITE_MAPBOX_KEY=
+VITE_DS_API_KEY=
+```
+
+
+The terminal will prompt the URI where you can access the web app.
+
+## About
+
+Most of the interesting code is in the `App.tsx` file. In the `updateLocation` method, the SDK is invoked.
+
+```javascript
+const updateLocation = async (resourceNo: string, latitude: number, longitude: number) => {
+  const location = new Models.ResourceGpsTracking();
+  location.resourceNo = resourceNo;
+  location.latitude = latitude;
+  location.longitude = longitude;
+
+  const client = new DimeSchedulerClient(apiKey);
+  await client.import(location);
+  }
+```
+
+## Application in action
+
+![](./assets/location.gif)

samples/update-resource-location/assets/location.gif

@@ -0,0 +1,16 @@
+<!doctype html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8" />
+  <link rel="icon" type="image/svg+xml" href="https://cdn.dimescheduler.com/dime-scheduler/v2/shape.svg" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Dime.Scheduler location tracker</title>
+</head>
+
+<body>
+  <div id="root"></div>
+  <script type="module" src="/src/main.tsx"></script>
+</body>
+
+</html>

samples/update-resource-location/bun.lockb

@@ -0,0 +1,32 @@
+{
+  "name": "ds-sample-locations",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "dimescheduler": "^0.0.1-alpha.35",
+    "mapbox-gl": "^3.3.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-hook-form": "^7.51.3"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.66",
+    "@types/react-dom": "^18.2.22",
+    "@typescript-eslint/eslint-plugin": "^7.2.0",
+    "@typescript-eslint/parser": "^7.2.0",
+    "@vitejs/plugin-react": "^4.2.1",
+    "eslint": "^8.57.0",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.6",
+    "tailwindcss": "^3.4.3",
+    "typescript": "^5.2.2",
+    "vite": "^5.2.0"
+  }
+}

samples/update-resource-location/index.html

@@ -0,0 +1,6 @@
+export default {
+  plugins: {
+    tailwindcss: {},
+    autoprefixer: {},
+  },
+}

samples/update-resource-location/package.json

@@ -0,0 +1,42 @@
+#root {
+  max-width: 1280px;
+  margin: 0 auto;
+  padding: 2rem;
+  text-align: center;
+}
+
+.logo {
+  height: 6em;
+  padding: 1.5em;
+  will-change: filter;
+  transition: filter 300ms;
+}
+.logo:hover {
+  filter: drop-shadow(0 0 2em #646cffaa);
+}
+.logo.react:hover {
+  filter: drop-shadow(0 0 2em #61dafbaa);
+}
+
+@keyframes logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  a:nth-of-type(2) .logo {
+    animation: logo-spin infinite 20s linear;
+  }
+}
+
+.card {
+  padding: 2em;
+}
+
+.read-the-docs {
+  color: #888;
+}