@shko.online/dataverse-odata 0.1.0 → 0.1.1

package/.babelrc.js

@@ -1,161 +1,161 @@
-const withTests = {
-    presets: [
-      [
-        '@babel/preset-env',
-        { shippedProposals: true, useBuiltIns: 'usage', corejs: '3', targets: { node: 'current' } },
-      ],
-    ],
-    plugins: [
-      '@storybook/babel-plugin-require-context-hook',
-      'babel-plugin-dynamic-import-node',
-      '@babel/plugin-transform-runtime',
-    ],
-  };
-  
-  // type BabelMode = 'cjs' | 'esm' | 'modern';
-  
-  const modules = process.env.BABEL_MODE === 'cjs' ? 'auto' : false;
-  
-  // FIXME: optional chaining introduced in chrome 80, not supported by wepback4
-  // https://github.com/webpack/webpack/issues/10227#issuecomment-642734920
-  const targets = process.env.BABEL_MODE === 'modern' ? { chrome: '79' } : 'defaults';
-  
-  module.exports = {
-    ignore: [
-      './lib/codemod/src/transforms/__testfixtures__',
-      './lib/postinstall/src/__testfixtures__',
-      '**/typings.d.ts',
-    ],
-    presets: [
-      [
-        '@babel/preset-env',
-        {
-          shippedProposals: true,
-          useBuiltIns: 'usage',
-          corejs: '3',
-          targets,
-          modules,
-        },
-      ],
-      '@babel/preset-typescript',
-      '@babel/preset-react',
-      '@babel/preset-flow',
-    ],
-    plugins: [
-      [
-        '@babel/plugin-proposal-decorators',
-        {
-          legacy: true,
-        },
-      ],
-      ['@babel/plugin-proposal-class-properties', { loose: true }],
-      ['@babel/plugin-proposal-private-methods', { loose: true }],
-      ['@babel/plugin-proposal-private-property-in-object', { loose: true }],
-      '@babel/plugin-proposal-export-default-from',
-      '@babel/plugin-syntax-dynamic-import',
-      ['@babel/plugin-proposal-object-rest-spread', { loose: true, useBuiltIns: true }],
-      'babel-plugin-macros',
-      ['@emotion', { sourceMap: true, autoLabel: 'always' }],
-    ],
-    env: {
-      test: withTests,
-    },
-    overrides: [
-      {
-        test: './examples/vue-kitchen-sink',
-        presets: ['@vue/babel-preset-jsx'],
-        env: {
-          test: withTests,
-        },
-      },
-      {
-        test: './lib',
-        presets: [
-          [
-            '@babel/preset-env',
-            {
-              shippedProposals: true,
-              useBuiltIns: 'usage',
-              corejs: '3',
-              modules,
-              targets,
-            },
-          ],
-          '@babel/preset-react',
-        ],
-        plugins: [
-          ['@babel/plugin-proposal-object-rest-spread', { loose: true, useBuiltIns: true }],
-          '@babel/plugin-proposal-export-default-from',
-          '@babel/plugin-syntax-dynamic-import',
-          ['@babel/plugin-proposal-private-property-in-object', { loose: true }],
-          ['@babel/plugin-proposal-class-properties', { loose: true }],
-          'babel-plugin-macros',
-          ['@emotion', { sourceMap: true, autoLabel: 'always' }],
-          'babel-plugin-add-react-displayname',
-        ],
-        env: {
-          test: withTests,
-        },
-      },
-      {
-        test: [
-          './lib/node-logger',
-          './lib/core',
-          './lib/core-common',
-          './lib/core-server',
-          './lib/builder-webpack4',
-          './lib/builder-webpack5',
-          './lib/codemod',
-          './addons/storyshots',
-          '**/src/server/**',
-          '**/src/bin/**',
-        ],
-        presets: [
-          [
-            '@babel/preset-env',
-            {
-              shippedProposals: true,
-              useBuiltIns: 'usage',
-              targets: {
-                node: '10',
-              },
-              modules,
-              corejs: '3',
-            },
-          ],
-        ],
-        plugins: [
-          '@emotion',
-          'babel-plugin-macros',
-          '@babel/plugin-transform-arrow-functions',
-          '@babel/plugin-transform-shorthand-properties',
-          '@babel/plugin-transform-block-scoping',
-          '@babel/plugin-transform-destructuring',
-          ['@babel/plugin-proposal-private-property-in-object', { loose: true }],
-          ['@babel/plugin-proposal-class-properties', { loose: true }],
-          '@babel/plugin-proposal-object-rest-spread',
-          '@babel/plugin-proposal-export-default-from',
-        ],
-        env: {
-          test: withTests,
-        },
-      },
-      {
-        test: ['**/virtualModuleEntry.template.js'],
-        presets: [
-          [
-            '@babel/preset-env',
-            {
-              shippedProposals: true,
-              useBuiltIns: 'usage',
-              targets: {
-                node: '10',
-              },
-              corejs: '3',
-              modules: false,
-            },
-          ],
-        ],
-      },
-    ],
+const withTests = {
+    presets: [
+      [
+        '@babel/preset-env',
+        { shippedProposals: true, useBuiltIns: 'usage', corejs: '3', targets: { node: 'current' } },
+      ],
+    ],
+    plugins: [
+      '@storybook/babel-plugin-require-context-hook',
+      'babel-plugin-dynamic-import-node',
+      '@babel/plugin-transform-runtime',
+    ],
+  };
+  
+  // type BabelMode = 'cjs' | 'esm' | 'modern';
+  
+  const modules = process.env.BABEL_MODE === 'cjs' ? 'auto' : false;
+  
+  // FIXME: optional chaining introduced in chrome 80, not supported by wepback4
+  // https://github.com/webpack/webpack/issues/10227#issuecomment-642734920
+  const targets = process.env.BABEL_MODE === 'modern' ? { chrome: '79' } : 'defaults';
+  
+  module.exports = {
+    ignore: [
+      './lib/codemod/src/transforms/__testfixtures__',
+      './lib/postinstall/src/__testfixtures__',
+      '**/typings.d.ts',
+    ],
+    presets: [
+      [
+        '@babel/preset-env',
+        {
+          shippedProposals: true,
+          useBuiltIns: 'usage',
+          corejs: '3',
+          targets,
+          modules,
+        },
+      ],
+      '@babel/preset-typescript',
+      '@babel/preset-react',
+      '@babel/preset-flow',
+    ],
+    plugins: [
+      [
+        '@babel/plugin-proposal-decorators',
+        {
+          legacy: true,
+        },
+      ],
+      ['@babel/plugin-proposal-class-properties', { loose: true }],
+      ['@babel/plugin-proposal-private-methods', { loose: true }],
+      ['@babel/plugin-proposal-private-property-in-object', { loose: true }],
+      '@babel/plugin-proposal-export-default-from',
+      '@babel/plugin-syntax-dynamic-import',
+      ['@babel/plugin-proposal-object-rest-spread', { loose: true, useBuiltIns: true }],
+      'babel-plugin-macros',
+      ['@emotion', { sourceMap: true, autoLabel: 'always' }],
+    ],
+    env: {
+      test: withTests,
+    },
+    overrides: [
+      {
+        test: './examples/vue-kitchen-sink',
+        presets: ['@vue/babel-preset-jsx'],
+        env: {
+          test: withTests,
+        },
+      },
+      {
+        test: './lib',
+        presets: [
+          [
+            '@babel/preset-env',
+            {
+              shippedProposals: true,
+              useBuiltIns: 'usage',
+              corejs: '3',
+              modules,
+              targets,
+            },
+          ],
+          '@babel/preset-react',
+        ],
+        plugins: [
+          ['@babel/plugin-proposal-object-rest-spread', { loose: true, useBuiltIns: true }],
+          '@babel/plugin-proposal-export-default-from',
+          '@babel/plugin-syntax-dynamic-import',
+          ['@babel/plugin-proposal-private-property-in-object', { loose: true }],
+          ['@babel/plugin-proposal-class-properties', { loose: true }],
+          'babel-plugin-macros',
+          ['@emotion', { sourceMap: true, autoLabel: 'always' }],
+          'babel-plugin-add-react-displayname',
+        ],
+        env: {
+          test: withTests,
+        },
+      },
+      {
+        test: [
+          './lib/node-logger',
+          './lib/core',
+          './lib/core-common',
+          './lib/core-server',
+          './lib/builder-webpack4',
+          './lib/builder-webpack5',
+          './lib/codemod',
+          './addons/storyshots',
+          '**/src/server/**',
+          '**/src/bin/**',
+        ],
+        presets: [
+          [
+            '@babel/preset-env',
+            {
+              shippedProposals: true,
+              useBuiltIns: 'usage',
+              targets: {
+                node: '10',
+              },
+              modules,
+              corejs: '3',
+            },
+          ],
+        ],
+        plugins: [
+          '@emotion',
+          'babel-plugin-macros',
+          '@babel/plugin-transform-arrow-functions',
+          '@babel/plugin-transform-shorthand-properties',
+          '@babel/plugin-transform-block-scoping',
+          '@babel/plugin-transform-destructuring',
+          ['@babel/plugin-proposal-private-property-in-object', { loose: true }],
+          ['@babel/plugin-proposal-class-properties', { loose: true }],
+          '@babel/plugin-proposal-object-rest-spread',
+          '@babel/plugin-proposal-export-default-from',
+        ],
+        env: {
+          test: withTests,
+        },
+      },
+      {
+        test: ['**/virtualModuleEntry.template.js'],
+        presets: [
+          [
+            '@babel/preset-env',
+            {
+              shippedProposals: true,
+              useBuiltIns: 'usage',
+              targets: {
+                node: '10',
+              },
+              corejs: '3',
+              modules: false,
+            },
+          ],
+        ],
+      },
+    ],
   };

package/.releaserc.yaml

@@ -0,0 +1,23 @@
+plugins:
+  - '@semantic-release/commit-analyzer'
+  - '@semantic-release/release-notes-generator'
+  - '@semantic-release/changelog'
+  - '@semantic-release/npm'
+  - '@semantic-release/exec'
+  - - '@semantic-release/git'
+    - assets:
+        - package.json
+        - CHANGELOG.md
+      message: |-
+        chore(release): ${nextRelease.version} [skip ci]
+
+        ${nextRelease.notes}
+branches:
+  - '+([0-9])?(.{+([0-9]),x}).x'
+  - main
+  - next
+  - next-major
+  - name: beta
+    prerelease: true
+  - name: alpha
+    prerelease: true

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [0.1.1](https://github.com/shko-online/dataverse-odata/compare/v0.1.0...v0.1.1) (2023-02-11)
+
+
+### Bug Fixes
+
+* improved documentation and type exports ([26c0b2f](https://github.com/shko-online/dataverse-odata/commit/26c0b2f8f6146007ed4f51a03ae64adbd3cf6ca5))

package/README.md

@@ -0,0 +1,3 @@
+# @shko.online/dataverse-odata
+This package will help parse OData strings (only the Microsoft Dataverse subset). It can be used as a validator, or you can build a javascript library which consumes the output of this library. We are using this to mock the `WebAPI` on the `@shko.online/componentframework-mock` package.
+

package/jest.config.ts

@@ -1,12 +1,12 @@
-import { JestConfigWithTsJest } from 'ts-jest';
-
-export default {
-  testMatch: [' **/tests/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[tj]s?(x)'],
-  clearMocks: true,
-  collectCoverage: true,
-  coverageDirectory: 'coverage',
-  coverageProvider: 'v8',
-  preset: 'ts-jest',
-  testEnvironment: 'jsdom',
-  coverageReporters: ['cobertura', 'text', 'html']
-} as JestConfigWithTsJest;
+import { JestConfigWithTsJest } from 'ts-jest';
+
+export default {
+  testMatch: [' **/tests/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[tj]s?(x)'],
+  clearMocks: true,
+  collectCoverage: true,
+  coverageDirectory: 'coverage',
+  coverageProvider: 'v8',
+  preset: 'ts-jest',
+  testEnvironment: 'jsdom',
+  coverageReporters: ['cobertura', 'text', 'html']
+} as JestConfigWithTsJest;

package/lib/cjs/getExpandFromParser.js

@@ -5,9 +5,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getExpandFromParser = void 0;
 var _getSelectFromParser = require("./getSelectFromParser");
-/**
- * Parses the $expand query
- * @returns Returns true when the parse has an error
+/**
+ * Parses the $expand query
+ * @returns Returns true when the parse has an error
  */
 const getExpandFromParser = (parser, result) => {
   const $expand = parser.get('$expand');

package/lib/cjs/getFetchXmlFromParser.js

@@ -4,9 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getFetchXmlFromParser = void 0;
-/**
- * Parses the $fetchXml query
- * @returns Returns true when the parse has an error
+/**
+ * Parses the fetchXml query
+ * @returns Returns true when the parse has an error
  */
 const getFetchXmlFromParser = (parser, result) => {
   const fetchXml = parser.get('fetchXml');

package/lib/cjs/getSelectFromParser.js

@@ -4,9 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getSelectFromParser = void 0;
-/**
- * Parses the $select query
- * @returns Returns true when the parse has an error
+/**
+ * Parses the $select query
+ * @returns Returns true when the parse has an error
  */
 const getSelectFromParser = (parser, result) => {
   const $select = parser.get('$select');

package/lib/cjs/getTopFromParser.js

@@ -4,9 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getTopFromParser = void 0;
-/**
- * Parses the $top query
- * @returns Returns true when the parse has an error
+/**
+ * Parses the $top query
+ * @returns Returns true when the parse has an error
  */
 const getTopFromParser = (parser, result) => {
   const $topValue = parser.get('$top');

package/lib/cjs/parseOData.js

@@ -8,6 +8,11 @@ var _getTopFromParser = require("./getTopFromParser");
 var _getSelectFromParser = require("./getSelectFromParser");
 var _getExpandFromParser = require("./getExpandFromParser");
 var _getFetchXmlFromParser = require("./getFetchXmlFromParser");
+/**
+ * parses the OData query and applies some Dataverse validations
+ * @param query The OData query
+ * @returns The parsed OData query
+ */
 const parseOData = query => {
   const parser = new URLSearchParams(query);
   const result = {};

package/lib/esm/getExpandFromParser.js

@@ -1,8 +1,8 @@
 import { getSelectFromParser } from './getSelectFromParser';
 
-/**
- * Parses the $expand query
- * @returns Returns true when the parse has an error
+/**
+ * Parses the $expand query
+ * @returns Returns true when the parse has an error
  */
 export const getExpandFromParser = (parser, result) => {
   const $expand = parser.get('$expand');

package/lib/esm/getFetchXmlFromParser.js

@@ -1,6 +1,6 @@
-/**
- * Parses the $fetchXml query
- * @returns Returns true when the parse has an error
+/**
+ * Parses the fetchXml query
+ * @returns Returns true when the parse has an error
  */
 export const getFetchXmlFromParser = (parser, result) => {
   const fetchXml = parser.get('fetchXml');

package/lib/esm/getSelectFromParser.js

@@ -1,6 +1,6 @@
-/**
- * Parses the $select query
- * @returns Returns true when the parse has an error
+/**
+ * Parses the $select query
+ * @returns Returns true when the parse has an error
  */
 export const getSelectFromParser = (parser, result) => {
   const $select = parser.get('$select');

package/lib/esm/getTopFromParser.js

@@ -1,6 +1,6 @@
-/**
- * Parses the $top query
- * @returns Returns true when the parse has an error
+/**
+ * Parses the $top query
+ * @returns Returns true when the parse has an error
  */
 export const getTopFromParser = (parser, result) => {
   const $topValue = parser.get('$top');

package/lib/esm/parseOData.js

@@ -2,6 +2,12 @@ import { getTopFromParser } from './getTopFromParser';
 import { getSelectFromParser } from './getSelectFromParser';
 import { getExpandFromParser } from './getExpandFromParser';
 import { getFetchXmlFromParser } from './getFetchXmlFromParser';
+
+/**
+ * parses the OData query and applies some Dataverse validations
+ * @param query The OData query
+ * @returns The parsed OData query
+ */
 export const parseOData = query => {
   const parser = new URLSearchParams(query);
   const result = {};

package/lib/getExpandFromParser.d.ts

@@ -1,7 +1,7 @@
-import type { ODataQuery } from './OData.types';
-/**
- * Parses the $expand query
- * @returns Returns true when the parse has an error
- */
-export declare const getExpandFromParser: (parser: URLSearchParams, result: ODataQuery) => boolean;
+import type { ODataQuery } from './OData.types';
+/**
+ * Parses the $expand query
+ * @returns Returns true when the parse has an error
+ */
+export declare const getExpandFromParser: (parser: URLSearchParams, result: ODataQuery) => boolean;
 //# sourceMappingURL=getExpandFromParser.d.ts.map