react-obsidian 1.0.0 → 1.2.0

package/.eslintrc.json

@@ -1,104 +0,0 @@
-{
-    "root": true,
-    "env": {
-        "es2021": true,
-        "jest": true
-    },
-    "ignorePatterns": ["**/*.config.js"],
-    "extends": [
-        "airbnb-base",
-        "airbnb-typescript",
-        "plugin:react/recommended",
-        "plugin:@typescript-eslint/recommended",
-        "plugin:import/typescript"
-    ],
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "project": "./tsconfig.json",
-        "ecmaVersion": 2021,
-        "sourceType": "module",
-        "ecmaFeatures": {
-          "jsx": true
-      }
-    },
-    "plugins": [
-        "react",
-        "@typescript-eslint",
-        "import-newlines",
-        "unused-imports"
-    ],
-    "rules": {
-      "max-len": ["error", {"code": 115}],
-      "lines-between-class-members": ["error", "always", {"exceptAfterSingleLine": true}],
-      "import/extensions": "off",
-      "@typescript-eslint/no-non-null-assertion": "off",
-      "no-useless-constructor": "off",
-      "@typescript-eslint/member-delimiter-style": "error",
-      "import/no-unresolved": "off",
-      "class-methods-use-this": "off",
-      "react/jsx-filename-extension": ["error", {"extensions": [".js", ".ts", ".jsx", ".tsx"]}],
-      "react/jsx-props-no-spreading": "off",
-      "no-use-before-define": "off",
-      "@typescript-eslint/no-use-before-define": ["off"],
-      "no-restricted-syntax": "off",
-      "import/no-named-as-default": "off",
-      "@typescript-eslint/ban-types": ["off"],
-      "import/no-extraneous-dependencies": ["error", {"devDependencies": true}],
-      "max-classes-per-file": ["off"],
-      "curly": ["error", "multi-line"],
-      "semi": ["error", "always"],
-      "comma-dangle": ["error", "always-multiline"],
-      "function-call-argument-newline": ["error", "consistent"],
-      "function-paren-newline": ["error", "multiline-arguments"],
-      "object-curly-newline": [
-        "error",
-        {
-          "ObjectExpression": {
-            "multiline": true,
-            "consistent": true
-          },
-          "ObjectPattern": {
-            "multiline": true,
-            "consistent": true
-          }
-        }
-      ],
-      "no-whitespace-before-property": "error",
-      "import-newlines/enforce": [
-        "error",
-        {
-            "items": 3,
-            "max-len": 115,
-            "semi": false
-        }
-      ],
-      "react/display-name": "off",
-      "no-plusplus": "off",
-      "no-trailing-spaces": "error",
-      "no-shadow": "off",
-      "@typescript-eslint/no-shadow": ["error", {"allow": ["Graph"]}],
-      "react/button-has-type": "off",
-      "react/jsx-one-expression-per-line": ["off"],
-      "arrow-body-style": ["off"],
-      "@typescript-eslint/quotes": ["error", "single", {"avoidEscape": true, "allowTemplateLiterals": true}],
-      "@typescript-eslint/lines-between-class-members": "off",
-      "@typescript-eslint/no-explicit-any": "off",
-      "import/prefer-default-export": "off",
-      "@typescript-eslint/no-unused-vars": "off",
-      "unused-imports/no-unused-imports": "error",
-		  "unused-imports/no-unused-vars": [
-			  "error",
-			  { "vars": "all", "varsIgnorePattern": "^_", "args": "after-used", "argsIgnorePattern": "^_" }
-		  ]
-    },
-    "settings": {
-      "import/resolver": {
-        "node": {
-          "extensions": [".js", ".jsx", ".ts", ".tsx"]
-        }
-      },
-      "react": {
-        "version": "detect"
-      }
-    }
-}

package/.vscode/settings.json

@@ -1,5 +0,0 @@
-{
-  "cSpell.words": [
-    "unmagler"
-  ]
-}

package/babel.config.js

@@ -1,13 +0,0 @@
-module.exports = {
-  presets: [
-    ['@babel/preset-env', { targets: { node: 'current' }}],
-    ['@babel/preset-typescript', {'onlyRemoveTypeImports': true}],
-    '@babel/preset-react',
-  ],
-  plugins: [
-    `${__dirname}/dist/transformers/babel-plugin-obsidian`,
-    ['@babel/plugin-proposal-decorators', { legacy: true }],
-    '@babel/plugin-transform-class-properties',
-    'babel-plugin-parameter-decorator'
-  ],
-};

package/documentation/README.md

@@ -1,41 +0,0 @@
-# Website
-
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
-
-### Installation
-
-```
-$ yarn
-```
-
-### Local Development
-
-```
-$ yarn start
-```
-
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
-
-### Build
-
-```
-$ yarn build
-```
-
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
-
-### Deployment
-
-Using SSH:
-
-```
-$ USE_SSH=true yarn deploy
-```
-
-Not using SSH:
-
-```
-$ GIT_USER=<Your GitHub username> yarn deploy
-```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

package/documentation/babel.config.js

@@ -1,3 +0,0 @@
-module.exports = {
-  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
-};

package/documentation/blog/2019-05-28-first-blog-post.md

@@ -1,12 +0,0 @@
----
-slug: first-blog-post
-title: First Blog Post
-authors:
-  name: Gao Wei
-  title: Docusaurus Core Team
-  url: https://github.com/wgao19
-  image_url: https://github.com/wgao19.png
-tags: [hola, docusaurus]
----
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

package/documentation/blog/2019-05-29-long-blog-post.md

@@ -1,44 +0,0 @@
----
-slug: long-blog-post
-title: Long Blog Post
-authors: endi
-tags: [hello, docusaurus]
----
-
-This is the summary of a very long blog post,
-
-Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
-
-<!--truncate-->
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

package/documentation/blog/2021-08-01-mdx-blog-post.mdx

@@ -1,20 +0,0 @@
----
-slug: mdx-blog-post
-title: MDX Blog Post
-authors: [slorber]
-tags: [docusaurus]
----
-
-Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
-
-:::tip
-
-Use the power of React to create interactive blog posts.
-
-```js
-<button onClick={() => alert('button clicked!')}>Click me!</button>
-```
-
-<button onClick={() => alert('button clicked!')}>Click me!</button>
-
-:::

package/documentation/blog/2021-08-26-welcome/index.md

@@ -1,25 +0,0 @@
----
-slug: welcome
-title: Welcome
-authors: [slorber, yangshun]
-tags: [facebook, hello, docusaurus]
----
-
-[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
-
-Simply add Markdown files (or folders) to the `blog` directory.
-
-Regular blog authors can be added to `authors.yml`.
-
-The blog post date can be extracted from filenames, such as:
-
-- `2019-05-30-welcome.md`
-- `2019-05-30-welcome/index.md`
-
-A blog post folder can be convenient to co-locate blog post images:
-
-![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg)
-
-The blog supports tags as well!
-
-**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.

package/documentation/blog/authors.yml

@@ -1,17 +0,0 @@
-endi:
-  name: Endilie Yacop Sucipto
-  title: Maintainer of Docusaurus
-  url: https://github.com/endiliey
-  image_url: https://github.com/endiliey.png
-
-yangshun:
-  name: Yangshun Tay
-  title: Front End Engineer @ Facebook
-  url: https://github.com/yangshun
-  image_url: https://github.com/yangshun.png
-
-slorber:
-  name: Sébastien Lorber
-  title: Docusaurus maintainer
-  url: https://sebastienlorber.com
-  image_url: https://github.com/slorber.png

package/documentation/docs/documentation/documentation.mdx

@@ -1,190 +0,0 @@
----
-sidebar_position: 1
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-
-# Introduction
-
-Obsidian is a dependency injection container with first-class support for React and React Native applications.
-
-Get started by **following the installation guide** bellow. Or **try Obsidian immediately** in the **[Online Playground](/playground)**.
-
-## The 2 steps tutorial for injecting dependencies with Obsidian
-
-### Step 1: Declare how dependencies should be created
-
-Define a singleton graph that is instantiated once and is retained throughout the lifespan of the application. All dependencies it provides are also singletons. The graph bellow provides two dependencies that can be injected: `fooService` and `barManager`.
-```ts title="A singleton graph that provides two dependencies"
-import {Singleton, Graph, ObjectGraph, Provides} from 'react-obsidian';
-
-
-@Singleton() @Graph()
-export class ApplicationGraph extends ObjectGraph {
-
- // fooService requires a barManager so it receives one as a parameter.
-  @Provides()
-  fooService(barManager: BarManager): FooService {
-    return new FooService(barManager);
-  }
-
-
-  @Provides()
-  barManager(): BarManager {
-    return new BarManager();
-  }
-}
-```
-
-### Step 2: Inject the dependencies
-Obsidian can inject dependencies into components, hooks, and classes.
-
-
-
-<Tabs>
-  <TabItem value="functionalComponent" label="Functional component injection" default>
-
-Injecting React functional components essentially revolves around two things: declaring the required dependencies in the components's props and exporting an injected component using the `injectComponent` function.
-
-```ts title="MyComponent.tsx"
-import {DependenciesOf, injectComponent} from 'react-obsidian';
-import {ApplicationGraph} from './ApplicationGraph';
-
-// 1. Declare which dependencies should be injected.
-type Props = DependenciesOf<ApplicationGraph, 'fooService'>; // {fooService: FooService}
-
-// 2. Implement the component.
-const myComponent = ({fooService}: Props) => {
-  // Do something useful with fooService
-}
-
-// 3. Export the injected component.
-export default injectComponent(myComponent, ApplicationGraph);
-```
-
-Now we can use the injected component without providing its dependencies manually:
-```tsx title="SomeComponent.tsx"
-import MyComponent from './MyComponent';
-
-const SomeComponent = () => {
-  // 4. Render the component - its dependencies are resolved automatically by Obsidian.
-  return <MyComponent />;
-}
-```
-  </TabItem>
-  <TabItem value="hook" label="Hook injection">
-
-Hooks are injected in a similar way to functional components. The only difference is that the `injectHook` function is used instead of `injectComponent`.
-
-```ts title="MyHook.ts"
-import {DependenciesOf, injectHook} from 'react-obsidian';
-import {ApplicationGraph} from './ApplicationGraph';
-
-// 1. Declare which dependencies should be injected.
-type Props = DependenciesOf<ApplicationGraph, 'fooService'>; // {fooService: FooService}
-
-// 2. Implement the hook.
-const myHook = ({fooService}: Props) => {
-  // Do something useful with fooService
-}
-
-// 3. Export the injected hook.
-export default injectHook(myHook, ApplicationGraph);
-```
-
-The injected hook can be used without providing its dependencies manually:
-```tsx title="SomeComponent.tsx"
-import myHook from './MyHook';
-
-const SomeComponent = () => {
-  // 4. Use the hook without providing any dependencies manually - they are injected automatically.
-  myHook();
-
-  return <>Obsidian is awesome!</>;
-}
-```
-  </TabItem>  
-  <TabItem value="classComponent" label="Class component injection">
-
-To inject a class, annotate it with the `@Injectable` decorator. The `@Injectable` decorator takes a single parameter - the graph that should be used to resolve the dependencies. Declare the dependencies as class members and annotate them with the `@Inject` decorator.
-
-```ts title="MyComponent.tsx"
-import {Injectable, Inject} from 'react-obsidian';
-import {ApplicationGraph} from './ApplicationGraph';
-
-@Injectable(ApplicationGraph)
-export MyClassComponent extends React.Component {
-  @Inject() private fooService!: FooService;
-
-}
-```
-
-Render the injected component. Obsidian resolves the required dependencies automatically.
-```tsx title="SomeComponent.tsx"
-import MyComponent from './MyComponent';
-
-const SomeComponent = () => {
-  // 4. Render the component - its dependencies are resolved automatically by Obsidian.
-  return <MyComponent />;
-}
-```
-
-  </TabItem>
-  <TabItem value="class" label="Class constructor injection">
-
-To inject a class, annotate it with the `@Injectable` decorator. The `@Injectable` decorator takes a single parameter - the graph that should be used to resolve the dependencies.
-Declare the dependencies as constructor parameters and annotate them with the `@Inject` decorator.
-
-```ts title="MyClass.tsx"
-import {Injectable, Inject} from 'react-obsidian';
-import {ApplicationGraph} from './ApplicationGraph';
-
-@Injectable(ApplicationGraph)
-export MyClass {
-  constructor (fooService?: FooService);
-  constructor(@Inject() private fooService: FooService) { }
-}
-```
-
-Now we can use the injected class without providing its dependencies manually:
-```ts
-const myClass = new MyClass();
-```
-
-Of course, passing dependencies explicitly is still possible:
-```ts
-const myClass = new MyClass(new FooService());
-```
-
-  </TabItem>
-</Tabs>
-
-___
-
-## Features
-
-* ⚛️ Inject all React constructs
-  * Functional components
-  * Hooks
-  * Class components
-* 🛠 Improve code structure
-  * Easily write object-oriented code with Single Responsibility in mind
-  * Eliminate circular dependencies
-  * Avoid implicit dependencies to make your code easier to reason about
-* ❤️ Developer experience
-  * Seamlessly integrates into existing projects
-  * Easy to adopt gradually
-  * Scales well
-  * Idiomatic API that's easy to understand
-
-## Design principles
-
-React Obsidian is guided by the principles of the Dependency Injection pattern, but does not strictly follow them. We allowed ourselves a degree of freedom when designing the library in order to reduce boilerplate code and library footprint.
-
-* **Easy to start** - Obsidian requires very little code to get you started. Once you declare a graph, using it to inject dependencies requires as little as two lines of code.
-* **Intuitive API** - The API should be verbose and understandable even to new users without prior experience with Dependency Injection.
-* **Minimal boilerplate** - Require the bare minimum in order to construct dependencies and resolve them. 
-
-<!-- ## Comparison with other libraries -->

package/documentation/docs/documentation/installation.mdx

@@ -1,56 +0,0 @@
----
-sidebar_position: 2
----
-
-# Installation
-
-Like most Dependency Injection frameworks, Obsidian uses automatic code generation to create the bindings necessary for resolving dependencies. This approach helps reduce the amount of boilerplate code required by developers. Obsidian relies on Babel for code generation, so you'll need to have Babel configured in your project.
-
-## 1. Install Obsidian
-
-```bash
-npm install react-obsidian
-```
-
-## 2. Install Reflect-metadata
-First, install and enable the reflect-metadata polyfill.
-```bash
-npm install reflect-metadata
-```
-
-Then, add the following line to the top of your application's entry point (usually index.js or index.ts):
-```js
-import 'reflect-metadata';
-```
-
-## 3. Enable experimental decorators
-Obsidian uses the Decorators feature whose proposal is at stage 3.
-
-Add the following options to your tsconfig.json file.
-
-```js
-{
-  "compilerOptions": {
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true
-  }
-}
-```
-
-## 4. Add the required Babel plugins
-Add the transformer to the list of plugins in your `.babel` file.
-
-```diff
-module.exports = {
-  presets: [
-    'module:metro-react-native-babel-preset',
-+    ['@babel/preset-typescript', {'onlyRemoveTypeImports': true}]
-  ],
-  plugins: [
-+    react-obsidian/dist/transformers/babel-plugin-obsidian,
-+    ['@babel/plugin-proposal-decorators', {legacy: true}],
-+    '@babel/plugin-transform-class-properties',
-+    'babel-plugin-parameter-decorator'
-  ]
-};
-```

package/documentation/docs/documentation/meta/clearingGraphs.mdx

@@ -1,13 +0,0 @@
----
-sidebar_position: 2
-title: "Clearing graphs"
----
-
-Graphs can be cleared by invoking the `Obsidian.clearGraphs()` function. This is useful in tests or when you need to reset the system to it's original state, for example after a user logs out.
-
-#### Clearing graphs automatically during execution of Jest tests
-Create a `jest.setup.js` file and add it to [setupFilesAfterEnv](https://jestjs.io/docs/configuration#setupfilesafterenv-array). Then, import the following file when ensures graphs are cleared before each test.
-
-```js
-import 'react-obsidian/clearGraphs';
-```

package/documentation/docs/documentation/meta/middlewares.mdx

@@ -1,27 +0,0 @@
----
-sidebar_position: 1
-title: "Graph middlewares"
----
-
-Graph middlewares let you plug into the graph creation process and modify the graph in any way you want. This is useful when working on large scale applications where "observability" is a key concern. For example, you can use a middleware to swizzle providers, add logging, or even add a new provider to the graph.
-
-Middleware follow the Chain of Responsibility pattern and therefore must always return a graph, either by creating one explicitly or by returning the instance created by another member in the resolve chain.
-
-## Example: adding a logging middleware
-The following example demonstrates how to add a middleware that's used for logging purposes.
-
-```ts
-import { GraphMiddleware } from 'react-obsidian';
-
-const loggingMiddleware = new class extends GraphMiddleware {
-      resolve<Props>(resolveChain: GraphResolveChain, Graph: Constructable<T>, props?: Props) {
-        const t1 = Date.now();
-        const graph = resolveChain.proceed(Graph, props);
-        const t2 = Date.now();
-        console.log(`Graph created in ${t2 - t1} milliseconds`);
-        return graph;
-      }
-    }();
-
-Obsidian.addGraphMiddleware(loggingMiddleware);
-```

package/documentation/docs/documentation/usage/ClassComponents.mdx

@@ -1,18 +0,0 @@
----
-sidebar_position: 4
-title: "Class components"
----
-
-## Injecting class components
-Injecting class components is a two step process. First, annotate the class with the `@Injectable` annotation and pass the graph from which dependencies should be resolve. Then, declare the dependencies as class members and annotate them with the `@Inject` annotation.
-
-```ts
-import {Injectable, Inject} from 'react-obsidian';
-import {ApplicationGraph} from './ApplicationGraph';
-
-@Injectable(ApplicationGraph)
-export class ClassComponent extends React.Component {
-  @Inject() private httpClient!: HttpClient;
-  
-}
-```

package/documentation/docs/documentation/usage/Classes.mdx

@@ -1,41 +0,0 @@
----
-sidebar_position: 5
-title: "Classes"
----
-
-## Injecting classes
-Injecting classes is a two step process. First, annotate the class with the `@Injectable` annotation and pass the graph from which dependencies should be resolve. Then, declare the dependencies as class members and annotate them with the `@Inject` annotation.
-
-```ts
-import {Injectable, Inject} from 'react-obsidian';
-import {ApplicationGraph} from './ApplicationGraph';
-
-@Injectable(ApplicationGraph)
-export class MyClass {
-  @Inject() private httpClient!: HttpClient;
-  
-}
-```
-
-:::important Always prefer constructor injection over field injection
-Constructor injection is the preferred way to inject dependencies. It is more explicit and easier to test. **Field injection should only be used when a class is not instantiated by a graph.**
-:::
-
-## Delayed injection
-Dependencies annotated with the `@Inject` annotation are resolved immediately **after** the constructor is called. If you want to inject a class at a later point in time, you can use the `@LateInject` annotation instead, and inject the dependencies by manually with the `Obsidian.inject()` function.
-
-```ts
-import {Injectable, LateInject} from 'react-obsidian';
-import {ApplicationGraph} from './ApplicationGraph';
-
-@Injectable(ApplicationGraph)
-export class MyClass {
-  @LateInject() private httpClient!: HttpClient;
-
-  public init() {
-    console.log(this.httpClient === undefined); // true
-    Obsidian.inject(this);
-    console.log(this.httpClient === undefined); // false
-  }
-}
-```