Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thomaspoignant/scim-patch
Simple library to perform SCIM patch as describe in RFC 7644 https://tools.ietf.org/html/rfc7644#section-3.5.2
https://github.com/thomaspoignant/scim-patch
library nodejs npm-package patch patcher scim scim-2 scim-patch
Last synced: 9 days ago
JSON representation
Simple library to perform SCIM patch as describe in RFC 7644 https://tools.ietf.org/html/rfc7644#section-3.5.2
- Host: GitHub
- URL: https://github.com/thomaspoignant/scim-patch
- Owner: thomaspoignant
- License: unlicense
- Created: 2019-11-29T13:12:44.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-30T04:03:50.000Z (6 months ago)
- Last Synced: 2024-05-01T16:03:37.657Z (6 months ago)
- Topics: library, nodejs, npm-package, patch, patcher, scim, scim-2, scim-patch
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/scim-patch
- Size: 1.4 MB
- Stars: 24
- Watchers: 3
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# SCIM-PATCH
[](https://npmjs.org/package/scim-patch "View this project on npm")
[](https://npmjs.com/package/scim-patch)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fthomaspoignant%2Fscim-patch?ref=badge_shield)
[](https://coveralls.io/github/thomaspoignant/scim-patch?branch=master&service=github)
[](https://sonarcloud.io/dashboard?id=thomaspoignant_scim-patch)
[RFC7644 SCIM(System for Cross-domain Identity Management) 2.0](https://tools.ietf.org/html/rfc7644#section-3.5.2) implementation of the "Modifying with PATCH" section 3.5.2.
## TL;DR
Important things to know, this library can :
- Validate a SCIM Patch query.
- Patch a SCIM resource from a SCIM Patch Query.
Want to have an example on how it works, [check this example](./example/example.ts).
## More Details
This library is implementing the `3.5.2. Modifying with PATCH` chapter of the SCIM RFC https://tools.ietf.org/html/rfc7644#section-3.5.2.
It will allow you to create a SCIM resources and to patch them using the SCIM Query language.
### Validation of a SCIM Query.
```typescript
import {patchBodyValidation} from 'scim-patch';
const scimBody: ScimPatchOperation =
{
'schemas': ['urn:ietf:params:scim:api:messages:2.0:PatchOp'],
'Operations': [
{op: 'replace', path: 'name.familyName', value: 'newFamilyName'}
]
};
try {
patchBodyValidation(scimBody);
} catch (error) {
// Here if there are an error in you SCIM request.
}
```
### Patch a SCIM resource from a SCIM Patch Query.
This implements the PATCH of a SCIM object from a SCIM Query.
You should create a valid SCIM resource by extending the [ScimResource interface](src/types.ts).
```typescript
export interface ScimUser extends ScimResource {
schemas: ['urn:ietf:params:scim:schemas:core:2.0:User'];
userName: string;
name: {
familyName: string;
givenName: string;
};
active: boolean;
emails: Array<{
value: string;
primary: boolean;
}>;
roles?: Array<{
value: string;
type?: string;
}>;
meta: ScimMeta & { resourceType: 'User' };
};
```
After you have created your object you can patch it by calling the `scimPatch` operation.
```typescript
const scimUser: ScimUser = {
schemas: ['urn:ietf:params:scim:schemas:core:2.0:User'],
userName: '[email protected]',
name: { familyName: 'user1', givenName: 'user2' },
active: true,
emails: [{value: '[email protected]', primary: true}],
meta: { resourceType: 'User', created: new Date(), lastModified: new Date() }
};
const patch: ScimPatchOperation = { op: 'replace', value: { active: false } };
const patchedUser = scimPatch(scimUser, patch);
// scimUser === patchedUser, see Options section if you want to avoid updating the original object
```
This particular operation will return :
```json
{
"schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ],
"userName": "[email protected]",
"name": { "familyName": "user1", "givenName": "user2" },
"active": false,
"emails": [{"value": "[email protected]", "primary": true }],
"meta": { "resourceType": "User", "created": "2019-12-19T14:36:08.838Z", "lastModified": "2019-12-19T14:36:08.838Z" }
}
```
#### Options
##### Mutate Document
By default `scimPatch()` is updating the scim resource you pass in the function.
If you want to avoid this, you can add an option while calling `scimPatch()`, it will do a copy of the object and work
on this copy.
Your call will look like this now:
```typescript
const patchedUser = scimPatch(scimUser, patch, {mutateDocument: false});
// scimUser !== patchedUser
```
##### Treat Missing as Add
By default `scimPatch()` will treat as Add a replace operation that targets an attribute that does not exist.
If you prefer to throw an error instead, then set `treatMissingAsAdd: false`
```typescript
// scimUser has no addresses
const patch = {
op: 'replace',
path: 'addresses[type eq "work"].country',
value: 'Australia',
};
const patchedUser = scimPatch(scimUser, patch, {treatMissingAsAdd: false});
// patchedUser.addresses[0].country === "Australia"
```
# How can I contribute?
See the [contributor's guide](CONTRIBUTING.md) for some helpful tips.
## Contributors
Thanks so much to our contributors.
