{"_id":"@aivenio/figma-js","_rev":"26-f90eddb9bc2182ac6736be55879c7b36","name":"@aivenio/figma-js","dist-tags":{"latest":"1.10.2-beta.0"},"versions":{"1.10.2-beta.0":{"name":"@aivenio/figma-js","version":"1.10.2-beta.0","keywords":[],"license":"MIT","_id":"@aivenio/figma-js@1.10.2-beta.0","maintainers":[{"name":"aivenkimmob","email":"kimmob@aiven.io"}],"homepage":"https://github.com/jongold/figma-js#readme","bugs":{"url":"https://github.com/jongold/figma-js/issues"},"ava":{"files":["build/main/**/*.spec.js"],"sources":["build/main/**/*.js"],"failFast":true},"nyc":{"exclude":["**/*.spec.js"]},"dist":{"shasum":"e2b6de07a1cfae09c5a09c09823e648f29f19b3e","tarball":"https://registry.npmjs.org/@aivenio/figma-js/-/figma-js-1.10.2-beta.0.tgz","fileCount":15,"integrity":"sha512-dcu0/NapkI8yogS2G5ZpCay1oO4Q64k4Yqz97AAwm/T3hcmbemd1ptTMRT5/GyedF3pbKEwfqT8LbX98amYp0w==","signatures":[{"sig":"MEUCIBjZnXtCmyKMn0Q4Fw7/jc5LpQwLEP9htcE8dwNMyrM9AiEAxiXTX6Uu3BEkvqU614UCt7Dp18ORDFsiWU2YKzOnUMM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":110692,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh1wG9CRA9TVsSAnZWagAAXYUP/Aw8sQgJ/VXiClEb6MWs\nEkoVvKc/pYmA2BMS/y3IFO5BMEWol+PZVn+G9lb3rfZ2mOjwBWCXjOwKATxk\nGkoY9AhAeo2JnJgqpkDbgb05jVeE6O9/wKDw6YQdYHeeVqTaQEo/aXxbUEGO\nBGbVOyi/Ud2Y+153j7duBinwucSKGLcby/GtF5meVuGQk3DaHBwH1KLDTBBp\neNNtSe0/3Zg4qSBEow8gwZnLB9tKioxNsluMXEj74zPKJYV0YoihVWAVqhFf\nDSOgQrHMZAjNzUCcL9SiDOp4P3ZHnxfkYxoUSx48CLLKy5arUxs/2i+61o6a\nchLHxRUxWVm6s/fgZwxv4Uje0jX1PFoF9SV0hLU5xxp/1359AJpS781mCW1Z\n6vL7jTn9vfOPyFlZE7b1m/+Qf3HDrQwOryTd6ltHPG0LT+QE0G/SpuTveI8W\nb6vJP+gtFmYgD/Zzn+B56sYJm+UQpHkqOEKZE8o1/cHl2ZE7EZKuu/7aucwj\nmIbepza9DS8xy4KdjI40abvq2FP5LPjYx6tMYPDW8ZvNxs1MLiQOEfk9j1/c\n6wW4fDDR8FYeGmuaj2dkh1tDrs/1ZvIEiG1yCFEWoP4vqe2wD+PU6ogJylY0\nllLLMjdXJ405xlxLQJD27isvOdzl5ZVMy/Y3CGVLfV5OVT2qWY8gu9RCYPIS\nY5Y5\r\n=Ro3H\r\n-----END PGP SIGNATURE-----\r\n"},"main":"build/main/index.js","types":"build/main/index.d.ts","config":{"commitizen":{"path":"cz-conventional-changelog"}},"module":"build/module/index.js","engines":{"node":">=8.9"},"gitHead":"aacfda0d7d0bf6a6da0a18d5083b45ca7bf7ab45","scripts":{"all":"run-s doc:html","cov":"run-s build test:unit cov:html && opn coverage/index.html","doc":"run-s doc:html && opn build/docs/index.html","fix":"run-s fix:*","info":"npm-scripts-info","test":"run-s build test:*","build":"run-s clean && run-p build:*","clean":"trash build test","watch":"run-s clean build:main && run-p \"build:main -- -w\" \"test:unit -- --watch\"","release":"yarn prepare-release && yarn publish && git push && git push --tag","cov:html":"nyc report --reporter=html","cov:send":"nyc report --reporter=lcov > coverage.lcov && codecov","doc:html":"typedoc src/ --target ES6 --mode file --out build/docs","doc:json":"typedoc src/ --target ES6 --mode file --json build/docs/typedoc.json","test:nsp":"nsp check","zzzreset":"git clean -dfx && git reset --hard && npm i","cov:check":"nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100","test:lint":"tslint --project . && prettier \"src/**/*.ts\" --list-different","test:unit":"nyc --silent ava","build:main":"tsc -p tsconfig.json","fix:tslint":"tslint --fix --project .","zzzversion":"standard-version","doc:publish":"gh-pages -m \"[ci skip] Updates\" -d build/docs","build:module":"tsc -p tsconfig.module.json","fix:prettier":"prettier \"src/**/*.ts\" --write","zzzpreinstall":"node -e \"if(process.env.npm_execpath.indexOf('yarn') === -1) throw new Error('figma-js must be installed with Yarn: https://yarnpkg.com/')\"","prepare-release":"yarn build && yarn doc && yarn doc:publish"},"_npmUser":{"name":"aivenkimmob","email":"kimmob@aiven.io"},"prettier":{"singleQuote":true},"repository":{"url":"git+https://github.com/jongold/figma-js.git","type":"git"},"_npmVersion":"6.14.4","description":"A simple wrapper for the Figma API","directories":{},"greenkeeper":{"ignore":["@types/node"]},"_nodeVersion":"12.18.0","dependencies":{"axios":"^0.18.0"},"scripts-info":{"cov":"Rebuild, run tests, then create and open the coverage report","doc":"Generate HTML API documentation and open it in a browser","fix":"Try to automatically fix any linting problems","info":"Display information about the package scripts","test":"Lint and unit test the project","build":"Clean and rebuild the project","reset":"Delete all untracked files and reset the repo to the last commit","watch":"Watch and rebuild the project on save, then rerun relevant tests","doc:json":"Generate API documentation in typedoc JSON format","changelog":"Bump package.json version, update CHANGELOG.md, tag release","prepare-release":"One-step: clean, build, test, publish docs, and prep a release"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^1.0.0-beta.3","nsp":"^3.2.1","nyc":"^11.5.0","tslint":"^5.14.0","codecov":"^3.0.0","opn-cli":"^3.1.0","typedoc":"^0.14.2","gh-pages":"^1.0.0","prettier":"^1.16.4","trash-cli":"^1.4.0","typescript":"^3.3.3333","npm-run-all":"^4.1.2","npm-scripts-info":"^0.3.6","standard-version":"^4.0.0","tslint-immutable":"^5.4.0","tslint-config-prettier":"^1.18.0","cz-conventional-changelog":"^2.1.0"},"_npmOperationalInternal":{"tmp":"tmp/figma-js_1.10.2-beta.0_1593030409661_0.4656901491793799","host":"s3://npm-registry-packages"}}},"time":{"created":"2020-06-24T20:26:49.404Z","modified":"2026-05-05T20:48:01.611Z","1.10.2-beta.0":"2020-06-24T20:26:49.837Z"},"bugs":{"url":"https://github.com/jongold/figma-js/issues"},"license":"MIT","homepage":"https://github.com/jongold/figma-js#readme","keywords":[],"repository":{"url":"git+https://github.com/jongold/figma-js.git","type":"git"},"description":"A simple wrapper for the Figma API","maintainers":[{"email":"henri.kestio@aiven.io","name":"aiven-badasshenkka"},{"email":"joonas.longi@aiven.io","name":"joonas-aiven"},{"email":"vtai@aiven.io","name":"vtainio-aiven"},{"email":"samuli.suortti@gmail.com","name":"smulis"},{"email":"droidy@aiven.io","name":"droidy"},{"email":"team-space-invaders+npm@aiven.io","name":"aiven-npm-release-bot"},{"email":"roope.karhapaa@outlook.com","name":"roopekar"},{"email":"hannu.pousi@aiven.io","name":"pousi-aiven"},{"email":"tomer.shay@aiven.io","name":"tomershayaiven"},{"email":"roman.pozdnyakov@aiven.io","name":"romanpozd"}],"readme":"# Figma.js\n\nA simple wrapper for the Figma API.\n\nCool projects using this:\n- [figma-graphql](https://github.com/braposo/figma-graphql)\n- [figmint](https://github.com/tiltshift/figmint)\n\n## Usage\n\n[Full documentation](http://jongold.github.io/figma-js) is available on the web and most everything is typed with TypeScript.\n\n### Creating a client\n\nQuickest start is to grab a personal access token from your Figma account settings page\n\n```typescript\nimport * as Figma from 'figma-js';\n\nconst token = '12345';\n\nconst client = Figma.Client({\n  personalAccessToken: token\n});\n```\n\nOr if you're building an app with OAuth authentication, after you get back the OAuth access token…\n\n```typescript\nimport * as Figma from 'figma-js';\n\nconst token = '12345';\n\nconst client = Figma.Client({\n  accessToken: token\n});\n```\n\n### Doing cool things\n\nOnce you have instantiated a client, have fun!\n\n```typescript\nclient.file('file-id').then(({ data }) => {\n  console.log(data);\n});\n```\n\n### Just reusing types\n\nAll of the types in the Figma file format / API are exported.\n\n```typescript\nimport * as Figma from 'figma-js';\n\nconst textNode: Figma.Text = {\n  // … this should autocomplete if your editor is set up for it!\n};\n```\n\n## Contributing\n\nWe used the [`typescript-starter`](https://github.com/bitjson/typescript-starter) repo for this - refer to its README for more detailed instructions.\n\nHelpful development commands:\n\n```sh\nyarn watch\nyarn docs\nyarn docs:publish\n```\n\n### Contributions welcomed\n\n* [ ] [generate types automatically](https://github.com/jongold/figma-js/issues/1)\n* [ ] [add tests](https://github.com/jongold/figma-js/issues/2)\n\n### Committing\n\n```sh\nyarn global add commitizen\n\n# instead of git commit\n\ngit cz\n```\n\n## Contributors\n\n* [@jongold](https://github.com/jongold/) (Airbnb)\n* [@chrisdrackett](https://github.com/chrisdrackett/)\n","readmeFilename":"README.md"}