-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor and support analytics sdk (#9)
* move base client to util * move base client to util * rename * rename * rename * remove useless files * bugfix: edge case * cleanup dependencies * update docs * bugfix: fix empty selection query * analytics api * format docs * bump version * add test event
- Loading branch information
1 parent
55e5f14
commit 1e4ca18
Showing
40 changed files
with
7,463 additions
and
1,281 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 1,32 @@ | ||
| { | ||
| "env": { | ||
| "development": { | ||
| "presets": [ | ||
| [ | ||
| "babel-preset-env", | ||
| { | ||
| "targets": { | ||
| "node": "8" | ||
| } | ||
| } | ||
| ] | ||
| ], | ||
| "plugins": [] | ||
| }, | ||
| "browser": { | ||
| "presets": [ | ||
| [ | ||
| "babel-preset-env", | ||
| { | ||
| "targets": { | ||
| "browsers": "last 2 versions, ie 10-11" | ||
| }, | ||
| "modules": false | ||
| } | ||
| ] | ||
| ], | ||
| "plugins": [] | ||
| } | ||
| }, | ||
| "sourceMaps": true | ||
| } |
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 1,59 @@ | ||
| # [**@arcblock/analytics-js**](https://github.com/arcblock/arc-javascript-sdk) | ||
|
|
||
| [](https://travis-ci.org/ArcBlock/arc-javascript-sdk) | ||
| [](https://codecov.io/gh/ArcBlock/arc-javascript-sdk) | ||
| [](https://github.com/sindresorhus/xo) | ||
| [](https://github.com/prettier/prettier) | ||
| [](https://lass.js.org) | ||
| [](LICENSE) | ||
|
|
||
| > Analytics Javascript SDK for ArcBlock for both Node.js and Browser | ||
| > If you are using this SDK in browser environment, [babel-polyfill](https://babeljs.io/docs/en/babel-polyfill) is required. | ||
| ## Table of Contents | ||
|
|
||
| - [Install](#install) | ||
| - [Usage](#usage) | ||
| - [Contributors](#contributors) | ||
| - [License](#license) | ||
|
|
||
| ## Install | ||
|
|
||
| ```sh | ||
| npm install @arcblock/ocap-js | ||
| // or | ||
| yarn add @arcblock/ocap-js | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```js | ||
| const SDK = require('@arcblock/analytics-js'); | ||
|
|
||
| // init client | ||
| const client = new SDK(); | ||
|
|
||
| const result = await client.createEvent({ | ||
| clientTimestamp: 'abc', | ||
| deviceId: 'abc', | ||
| eventType: 'abc', | ||
| objectId: 'abc', | ||
| objectType: 'abc', | ||
| operation: 'abc', | ||
| source: 'abc', | ||
| userId: 'abc', | ||
| }); | ||
| ``` | ||
|
|
||
| ## Contributors | ||
|
|
||
| | Name | Website | | ||
| | -------------- | -------------------------- | | ||
| | **wangshijun** | <https://ocap.arcblock.io> | | ||
|
|
||
| - wangshijun | ||
|
|
||
| ## License | ||
|
|
||
| [MIT](LICENSE) © [wangshijun](https://ocap.arcblock.io) |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 1,68 @@ | ||
| # ANALYTICS API List | ||
|
|
||
| ## Queries | ||
|
|
||
| No Queries supported yet. | ||
|
|
||
| ## Subscriptions | ||
|
|
||
| No Subscriptions supported yet. | ||
|
|
||
| ## Mutations | ||
|
|
||
| ### createEvent | ||
|
|
||
| #### Arguments | ||
|
|
||
| - **city**, optional, Client's city | ||
| - **clientTimestamp**, **required**, Specifies the timestamp when client makes the request | ||
| - **country**, optional, Client's country | ||
| - **deviceId**, **required**, Client's deviceID | ||
| - **eventContent**, optional, Specifies the content of this event.We will define it in detail in future | ||
| - **eventType**, **required**, Specifies the type of this event. Examples:interaction, activity | ||
| - **ip**, optional, Client's IP address | ||
| - **language**, optional, The language client uses | ||
| - **latitude**, optional, Client's latitude | ||
| - **longitude**, optional, Client's longitude | ||
| - **objectId**, **required**, Specifies the object ID of this activity | ||
| - **objectType**, **required**, Specifies the type of the object | ||
| - **operation**, **required**, Specifies the operation of this event | ||
| - **postalCode**, optional, Client's postal code | ||
| - **responseTime**, optional, Specifies the time it took for server to respond. The value is in milliseconds | ||
| - **serverTimestamp**, optional, Specifies the timestamp when server receives the request | ||
| - **source**, **required**, Specifies which application/service this event belongs to.Example:Playground, OCAP | ||
| - **targetId**, optional, Specifies the target ID of this activity | ||
| - **targetType**, optional, Specifies the type of the target | ||
| - **userAgent**, optional, The User Agent of the browser | ||
| - **userId**, **required**, Client's userID | ||
|
|
||
| #### Result Format | ||
|
|
||
| ```graphql | ||
| mutation { | ||
| createEvent( | ||
| clientTimestamp: "abc" | ||
| deviceId: "abc" | ||
| eventType: "abc" | ||
| objectId: "abc" | ||
| objectType: "abc" | ||
| operation: "abc" | ||
| source: "abc" | ||
| userId: "abc" | ||
| ) | ||
| } | ||
| ``` | ||
|
|
||
| ### createEvents | ||
|
|
||
| #### Arguments | ||
|
|
||
| - **data**, **required**, A list of analytics events | ||
|
|
||
| #### Result Format | ||
|
|
||
| ```graphql | ||
| mutation { | ||
| createEvents(data: 123) | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 1,180 @@ | ||
| // For a detailed explanation regarding each configuration property, visit: | ||
| // https://jestjs.io/docs/en/configuration.html | ||
|
|
||
| module.exports = { | ||
| // All imported modules in your tests should be mocked automatically | ||
| // automock: false, | ||
|
|
||
| // Stop running tests after the first failure | ||
| // bail: false, | ||
|
|
||
| // Respect "browser" field in package.json when resolving modules | ||
| browser: false, | ||
|
|
||
| // The directory where Jest should store its cached dependency information | ||
| // cacheDirectory: "/var/folders/wm/rb986xvs65n74yq6kylnr8cr0000gn/T/jest_dx", | ||
|
|
||
| // Automatically clear mock calls and instances between every test | ||
| clearMocks: true, | ||
|
|
||
| // Indicates whether the coverage information should be collected while executing the test | ||
| // collectCoverage: false, | ||
|
|
||
| // An array of glob patterns indicating a set of files for which coverage information should be collected | ||
| // collectCoverageFrom: null, | ||
|
|
||
| // The directory where Jest should output its coverage files | ||
| coverageDirectory: 'coverage', | ||
|
|
||
| // An array of regexp pattern strings used to skip coverage collection | ||
| // coveragePathIgnorePatterns: [ | ||
| // "/node_modules/" | ||
| // ], | ||
|
|
||
| // A list of reporter names that Jest uses when writing coverage reports | ||
| // coverageReporters: [ | ||
| // "json", | ||
| // "text", | ||
| // "lcov", | ||
| // "clover" | ||
| // ], | ||
|
|
||
| // An object that configures minimum threshold enforcement for coverage results | ||
| // coverageThreshold: null, | ||
|
|
||
| // Make calling deprecated APIs throw helpful error messages | ||
| // errorOnDeprecated: false, | ||
|
|
||
| // Force coverage collection from ignored files usin a array of glob patterns | ||
| // forceCoverageMatch: [], | ||
|
|
||
| // A path to a module which exports an async function that is triggered once before all test suites | ||
| // globalSetup: null, | ||
|
|
||
| // A path to a module which exports an async function that is triggered once after all test suites | ||
| // globalTeardown: null, | ||
|
|
||
| // A set of global variables that need to be available in all test environments | ||
| // globals: {}, | ||
|
|
||
| // An array of directory names to be searched recursively up from the requiring module's location | ||
| // moduleDirectories: [ | ||
| // "node_modules" | ||
| // ], | ||
|
|
||
| // An array of file extensions your modules use | ||
| // moduleFileExtensions: [ | ||
| // "js", | ||
| // "json", | ||
| // "jsx", | ||
| // "node" | ||
| // ], | ||
|
|
||
| // A map from regular expressions to module names that allow to stub out resources with a single module | ||
| // moduleNameMapper: {}, | ||
|
|
||
| // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader | ||
| // modulePathIgnorePatterns: [], | ||
|
|
||
| // Activates notifications for test results | ||
| // notify: false, | ||
|
|
||
| // An enum that specifies notification mode. Requires { notify: true } | ||
| // notifyMode: "always", | ||
|
|
||
| // A preset that is used as a base for Jest's configuration | ||
| // preset: null, | ||
|
|
||
| // Run tests from one or more projects | ||
| // projects: null, | ||
|
|
||
| // Use this configuration option to add custom reporters to Jest | ||
| // reporters: undefined, | ||
|
|
||
| // Automatically reset mock state between every test | ||
| // resetMocks: false, | ||
|
|
||
| // Reset the module registry before running each individual test | ||
| // resetModules: false, | ||
|
|
||
| // A path to a custom resolver | ||
| // resolver: null, | ||
|
|
||
| // Automatically restore mock state between every test | ||
| // restoreMocks: false, | ||
|
|
||
| // The root directory that Jest should scan for tests and modules within | ||
| // rootDir: null, | ||
|
|
||
| // A list of paths to directories that Jest should use to search for files in | ||
| // roots: [ | ||
| // "<rootDir>" | ||
| // ], | ||
|
|
||
| // Allows you to use a custom runner instead of Jest's default test runner | ||
| // runner: "jest-runner", | ||
|
|
||
| // The paths to modules that run some code to configure or set up the testing environment before each test | ||
| // setupFiles: [], | ||
|
|
||
| // The path to a module that runs some code to configure or set up the testing framework before each test | ||
| // setupTestFrameworkScriptFile: null, | ||
|
|
||
| // A list of paths to snapshot serializer modules Jest should use for snapshot testing | ||
| // snapshotSerializers: [], | ||
|
|
||
| // The test environment that will be used for testing | ||
| testEnvironment: 'node', | ||
|
|
||
| // Options that will be passed to the testEnvironment | ||
| // testEnvironmentOptions: {}, | ||
|
|
||
| // Adds a location field to test results | ||
| // testLocationInResults: false, | ||
|
|
||
| // The glob patterns Jest uses to detect test files | ||
| // testMatch: [ | ||
| // "**/__tests__/**/*.js?(x)", | ||
| // "**/?(*.) (spec|test).js?(x)" | ||
| // ], | ||
|
|
||
| // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped | ||
| // testPathIgnorePatterns: [ | ||
| // "/node_modules/" | ||
| // ], | ||
|
|
||
| // The regexp pattern Jest uses to detect test files | ||
| // testRegex: "", | ||
|
|
||
| // This option allows the use of a custom results processor | ||
| // testResultsProcessor: null, | ||
|
|
||
| // This option allows use of a custom test runner | ||
| // testRunner: "jasmine2", | ||
|
|
||
| // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href | ||
| // testURL: "http://localhost", | ||
|
|
||
| // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout" | ||
| // timers: "real", | ||
|
|
||
| // A map from regular expressions to paths to transformers | ||
| // transform: null, | ||
|
|
||
| // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation | ||
| // transformIgnorePatterns: [ | ||
| // "/node_modules/" | ||
| // ], | ||
|
|
||
| // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them | ||
| // unmockedModulePathPatterns: undefined, | ||
|
|
||
| // Indicates whether each individual test should be reported during the run | ||
| // verbose: null, | ||
|
|
||
| // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode | ||
| // watchPathIgnorePatterns: [], | ||
|
|
||
| // Whether to use watchman for file crawling | ||
| // watchman: true, | ||
| }; |
Oops, something went wrong.