honeymoose
/
sp-dev-fx-webparts
mirror of https://github.com/pnp/sp-dev-fx-webparts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DALL-E Image generator webpart sample added.

This commit is contained in:
Luis Mañez 2022-11-09 08:32:23 +01:00
parent 60923d94f7
commit d29c22b5ef
36 changed files with 43510 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

378
samples/react-dall-e-image-generation/.eslintrc.js Normal file
View File

@ -0,0 +1,378 @@
require('@rushstack/eslint-config/patch/modern-module-resolution');
module.exports = {
extends: ['@microsoft/eslint-config-spfx/lib/profiles/react'],
parserOptions: { tsconfigRootDir: __dirname },
overrides: [
{
files: ['*.ts', '*.tsx'],
parser: '@typescript-eslint/parser',
'parserOptions': {
'project': './tsconfig.json',
'ecmaVersion': 2018,
'sourceType': 'module'
},
rules: {
// Prevent usage of the JavaScript null value, while allowing code to access existing APIs that may require null. https://www.npmjs.com/package/@rushstack/eslint-plugin
'@rushstack/no-new-null': 1,
// Require Jest module mocking APIs to be called before any other statements in their code block. https://www.npmjs.com/package/@rushstack/eslint-plugin
'@rushstack/hoist-jest-mock': 1,
// Require regular expressions to be constructed from string constants rather than dynamically building strings at runtime. https://www.npmjs.com/package/@rushstack/eslint-plugin-security
'@rushstack/security/no-unsafe-regexp': 1,
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
'@typescript-eslint/adjacent-overload-signatures': 1,
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
//
// CONFIGURATION: By default, these are banned: String, Boolean, Number, Object, Symbol
'@typescript-eslint/ban-types': [
1,
{
'extendDefaults': false,
'types': {
'String': {
'message': 'Use \'string\' instead',
'fixWith': 'string'
},
'Boolean': {
'message': 'Use \'boolean\' instead',
'fixWith': 'boolean'
},
'Number': {
'message': 'Use \'number\' instead',
'fixWith': 'number'
},
'Object': {
'message': 'Use \'object\' instead, or else define a proper TypeScript type:'
},
'Symbol': {
'message': 'Use \'symbol\' instead',
'fixWith': 'symbol'
},
'Function': {
'message': 'The \'Function\' type accepts any function-like value.\nIt provides no type safety when calling the function, which can be a common source of bugs.\nIt also accepts things like class declarations, which will throw at runtime as they will not be called with \'new\'.\nIf you are expecting the function to accept certain arguments, you should explicitly define the function shape.'
}
}
}
],
// RATIONALE: Code is more readable when the type of every variable is immediately obvious.
// Even if the compiler may be able to infer a type, this inference will be unavailable
// to a person who is reviewing a GitHub diff. This rule makes writing code harder,
// but writing code is a much less important activity than reading it.
//
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
'@typescript-eslint/explicit-function-return-type': [
1,
{
'allowExpressions': true,
'allowTypedFunctionExpressions': true,
'allowHigherOrderFunctions': false
}
],
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
// Rationale to disable: although this is a recommended rule, it is up to dev to select coding style.
// Set to 1 (warning) or 2 (error) to enable.
'@typescript-eslint/explicit-member-accessibility': 0,
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
'@typescript-eslint/no-array-constructor': 1,
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
//
// RATIONALE: The "any" keyword disables static type checking, the main benefit of using TypeScript.
// This rule should be suppressed only in very special cases such as JSON.stringify()
// where the type really can be anything. Even if the type is flexible, another type
// may be more appropriate such as "unknown", "{}", or "Record<k,V>".
'@typescript-eslint/no-explicit-any': 1,
// RATIONALE: The #1 rule of promises is that every promise chain must be terminated by a catch()
// handler. Thus wherever a Promise arises, the code must either append a catch handler,
// or else return the object to a caller (who assumes this responsibility). Unterminated
// promise chains are a serious issue. Besides causing errors to be silently ignored,
// they can also cause a NodeJS process to terminate unexpectedly.
'@typescript-eslint/no-floating-promises': 2,
// RATIONALE: Catches a common coding mistake.
'@typescript-eslint/no-for-in-array': 2,
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
'@typescript-eslint/no-misused-new': 2,
// RATIONALE: The "namespace" keyword is not recommended for organizing code because JavaScript lacks
// a "using" statement to traverse namespaces. Nested namespaces prevent certain bundler
// optimizations. If you are declaring loose functions/variables, it's better to make them
// static members of a class, since classes support property getters and their private
// members are accessible by unit tests. Also, the exercise of choosing a meaningful
// class name tends to produce more discoverable APIs: for example, search+replacing
// the function "reverse()" is likely to return many false matches, whereas if we always
// write "Text.reverse()" is more unique. For large scale organization, it's recommended
// to decompose your code into separate NPM packages, which ensures that component
// dependencies are tracked more conscientiously.
//
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
'@typescript-eslint/no-namespace': [
1,
{
'allowDeclarations': false,
'allowDefinitionFiles': false
}
],
// RATIONALE: Parameter properties provide a shorthand such as "constructor(public title: string)"
// that avoids the effort of declaring "title" as a field. This TypeScript feature makes
// code easier to write, but arguably sacrifices readability: In the notes for
// "@typescript-eslint/member-ordering" we pointed out that fields are central to
// a class's design, so we wouldn't want to bury them in a constructor signature
// just to save some typing.
//
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
// Set to 1 (warning) or 2 (error) to enable the rule
'@typescript-eslint/no-parameter-properties': 0,
// RATIONALE: When left in shipping code, unused variables often indicate a mistake. Dead code
// may impact performance.
//
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
'@typescript-eslint/no-unused-vars': [
1,
{
'vars': 'all',
// Unused function arguments often indicate a mistake in JavaScript code. However in TypeScript code,
// the compiler catches most of those mistakes, and unused arguments are fairly common for type signatures
// that are overriding a base class method or implementing an interface.
'args': 'none'
}
],
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
'@typescript-eslint/no-use-before-define': [
2,
{
'functions': false,
'classes': true,
'variables': true,
'enums': true,
'typedefs': true
}
],
// Disallows require statements except in import statements.
// In other words, the use of forms such as var foo = require("foo") are banned. Instead use ES6 style imports or import foo = require("foo") imports.
'@typescript-eslint/no-var-requires': 'error',
// RATIONALE: The "module" keyword is deprecated except when describing legacy libraries.
//
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
'@typescript-eslint/prefer-namespace-keyword': 1,
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
// Rationale to disable: it's up to developer to decide if he wants to add type annotations
// Set to 1 (warning) or 2 (error) to enable the rule
'@typescript-eslint/no-inferrable-types': 0,
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
// Rationale to disable: declaration of empty interfaces may be helpful for generic types scenarios
'@typescript-eslint/no-empty-interface': 0,
// RATIONALE: This rule warns if setters are defined without getters, which is probably a mistake.
'accessor-pairs': 1,
// RATIONALE: In TypeScript, if you write x["y"] instead of x.y, it disables type checking.
'dot-notation': [
1,
{
'allowPattern': '^_'
}
],
// RATIONALE: Catches code that is likely to be incorrect
'eqeqeq': 1,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'for-direction': 1,
// RATIONALE: Catches a common coding mistake.
'guard-for-in': 2,
// RATIONALE: If you have more than 2,000 lines in a single source file, it's probably time
// to split up your code.
'max-lines': ['warn', { max: 2000 }],
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-async-promise-executor': 2,
// RATIONALE: Deprecated language feature.
'no-caller': 2,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-compare-neg-zero': 2,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-cond-assign': 2,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-constant-condition': 1,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-control-regex': 2,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-debugger': 1,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-delete-var': 2,
// RATIONALE: Catches code that is likely to be incorrect
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-duplicate-case': 2,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-empty': 1,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-empty-character-class': 2,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-empty-pattern': 1,
// RATIONALE: Eval is a security concern and a performance concern.
'no-eval': 1,
// RATIONALE: Catches code that is likely to be incorrect
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-ex-assign': 2,
// RATIONALE: System types are global and should not be tampered with in a scalable code base.
// If two different libraries (or two versions of the same library) both try to modify
// a type, only one of them can win. Polyfills are acceptable because they implement
// a standardized interoperable contract, but polyfills are generally coded in plain
// JavaScript.
'no-extend-native': 1,
// Disallow unnecessary labels
'no-extra-label': 1,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-fallthrough': 2,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-func-assign': 1,
// RATIONALE: Catches a common coding mistake.
'no-implied-eval': 2,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-invalid-regexp': 2,
// RATIONALE: Catches a common coding mistake.
'no-label-var': 2,
// RATIONALE: Eliminates redundant code.
'no-lone-blocks': 1,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-misleading-character-class': 2,
// RATIONALE: Catches a common coding mistake.
'no-multi-str': 2,
// RATIONALE: It's generally a bad practice to call "new Thing()" without assigning the result to
// a variable. Either it's part of an awkward expression like "(new Thing()).doSomething()",
// or else implies that the constructor is doing nontrivial computations, which is often
// a poor class design.
'no-new': 1,
// RATIONALE: Obsolete language feature that is deprecated.
'no-new-func': 2,
// RATIONALE: Obsolete language feature that is deprecated.
'no-new-object': 2,
// RATIONALE: Obsolete notation.
'no-new-wrappers': 1,
// RATIONALE: Catches code that is likely to be incorrect
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-octal': 2,
// RATIONALE: Catches code that is likely to be incorrect
'no-octal-escape': 2,
// RATIONALE: Catches code that is likely to be incorrect
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-regex-spaces': 2,
// RATIONALE: Catches a common coding mistake.
'no-return-assign': 2,
// RATIONALE: Security risk.
'no-script-url': 1,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-self-assign': 2,
// RATIONALE: Catches a common coding mistake.
'no-self-compare': 2,
// RATIONALE: This avoids statements such as "while (a = next(), a && a.length);" that use
// commas to create compound expressions. In general code is more readable if each
// step is split onto a separate line. This also makes it easier to set breakpoints
// in the debugger.
'no-sequences': 1,
// RATIONALE: Catches code that is likely to be incorrect
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-shadow-restricted-names': 2,
// RATIONALE: Obsolete language feature that is deprecated.
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-sparse-arrays': 2,
// RATIONALE: Although in theory JavaScript allows any possible data type to be thrown as an exception,
// such flexibility adds pointless complexity, by requiring every catch block to test
// the type of the object that it receives. Whereas if catch blocks can always assume
// that their object implements the "Error" contract, then the code is simpler, and
// we generally get useful additional information like a call stack.
'no-throw-literal': 2,
// RATIONALE: Catches a common coding mistake.
'no-unmodified-loop-condition': 1,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-unsafe-finally': 2,
// RATIONALE: Catches a common coding mistake.
'no-unused-expressions': 1,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-unused-labels': 1,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-useless-catch': 1,
// RATIONALE: Avoids a potential performance problem.
'no-useless-concat': 1,
// RATIONALE: The "var" keyword is deprecated because of its confusing "hoisting" behavior.
// Always use "let" or "const" instead.
//
// STANDARDIZED BY: @typescript-eslint\eslint-plugin\dist\configs\recommended.json
'no-var': 2,
// RATIONALE: Generally not needed in modern code.
'no-void': 1,
// RATIONALE: Obsolete language feature that is deprecated.
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'no-with': 2,
// RATIONALE: Makes logic easier to understand, since constants always have a known value
// @typescript-eslint\eslint-plugin\dist\configs\eslint-recommended.js
'prefer-const': 1,
// RATIONALE: Catches a common coding mistake where "resolve" and "reject" are confused.
'promise/param-names': 2,
// RATIONALE: Catches code that is likely to be incorrect
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'require-atomic-updates': 2,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'require-yield': 1,
// "Use strict" is redundant when using the TypeScript compiler.
'strict': [
2,
'never'
],
// RATIONALE: Catches code that is likely to be incorrect
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
'use-isnan': 2,
// STANDARDIZED BY: eslint\conf\eslint-recommended.js
// Set to 1 (warning) or 2 (error) to enable.
// Rationale to disable: !!{}
'no-extra-boolean-cast': 0,
// ====================================================================
// @microsoft/eslint-plugin-spfx
// ====================================================================
'@microsoft/spfx/import-requires-chunk-name': 1,
'@microsoft/spfx/no-require-ensure': 2,
'@microsoft/spfx/pair-react-dom-render-unmount': 1
}
},
{
// For unit tests, we can be a little bit less strict. The settings below revise the
// defaults specified in the extended configurations, as well as above.
files: [
// Test files
'*.test.ts',
'*.test.tsx',
'*.spec.ts',
'*.spec.tsx',
// Facebook convention
'**/__mocks__/*.ts',
'**/__mocks__/*.tsx',
'**/__tests__/*.ts',
'**/__tests__/*.tsx',
// Microsoft convention
'**/test/*.ts',
'**/test/*.tsx'
],
rules: {
'no-new': 0,
'class-name': 0,
'export-name': 0,
forin: 0,
'label-position': 0,
'member-access': 2,
'no-arg': 0,
'no-console': 0,
'no-construct': 0,
'no-duplicate-variable': 2,
'no-eval': 0,
'no-function-expression': 2,
'no-internal-module': 2,
'no-shadowed-variable': 2,
'no-switch-case-fall-through': 2,
'no-unnecessary-semicolons': 2,
'no-unused-expression': 2,
'no-with-statement': 2,
semicolon: 2,
'trailing-comma': 0,
typedef: 0,
'typedef-whitespace': 0,
'use-named-parameter': 2,
'variable-name': 0,
whitespace: 0
}
}
]
};

34
samples/react-dall-e-image-generation/.gitignore vendored Normal file
View File

@ -0,0 +1,34 @@
# Logs
logs
*.log
npm-debug.log*
# Dependency directories
node_modules
# Build generated files
dist
lib
release
solution
temp
*.sppkg
.heft
# Coverage directory used by tools like istanbul
coverage
# OSX
.DS_Store
# Visual Studio files
.ntvs_analysis.dat
.vs
bin
obj
# Resx Generated Code
*.resx.ts
# Styles Generated Code
*.scss.ts

16
samples/react-dall-e-image-generation/.npmignore Normal file
View File

@ -0,0 +1,16 @@
!dist
config
gulpfile.js
release
src
temp
tsconfig.json
tslint.json
*.log
.yo-rc.json
.vscode

16
samples/react-dall-e-image-generation/.yo-rc.json Normal file
View File

@ -0,0 +1,16 @@
{
"@microsoft/generator-sharepoint": {
"plusBeta": false,
"isCreatingSolution": true,
"version": "1.15.2",
"libraryName": "react-dall-e-image-generation",
"libraryId": "dd009cf4-7f8a-4811-9697-0771da80e3ad",
"environment": "spo",
"packageManager": "npm",
"solutionName": "react-dall-e-image-generation",
"solutionShortDescription": "react-dall-e-image-generation description",
"skipFeatureDeployment": true,
"isDomainIsolated": false,
"componentType": "webpart"
}
}

82
samples/react-dall-e-image-generation/README.md Normal file
View File

@ -0,0 +1,82 @@
# Image generation webpart using DALL-E API
## Summary
This webpart allows you to generate some images using the recently released API of [DALL-E image generation](https://openai.com/dall-e-2/). Once the image is generated, the webpart allows you to save it to the Documents library of the current site collection.
![./assets/react-dall-e-image-generation.gif](./assets/react-dall-e-image-generation.gif)
__Note__: The Images API is in beta. During this time the API and models will evolve based on your feedback. To ensure all users can prototype comfortably, the default rate limit is 10 images per minute, 25 per 5 minutes.
In this sample, we are calling the API asking for Base64 images format, while the default is a URL. We are using the Base64 format, because DALL-E servers do not support CORS, so we cannot fetch the image content to save it to SharePoint. To achieve this feature, we use the Base64 format.
## Used SharePoint Framework Version
![version](https://img.shields.io/badge/version-1.15-green.svg)
## Applies to
- [SharePoint Framework](https://aka.ms/spfx)
- [Microsoft 365 tenant](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant)
> Get your own free development tenant by subscribing to [Microsoft 365 developer program](http://aka.ms/o365devprogram)
## Prerequisites
For being able to use the API, you first needs to register into the [DALL-E 2 website](https://labs.openai.com/auth/signup), and then, you must generate an [API Key](https://beta.openai.com/account/api-keys)
## Solution
| Solution | Author(s) |
| ----------- | ------------------------------------------------------- |
| react-dall-e-image-generation | [Luis Mañez](https://github.com/luismanez) ([MS MVP](https://mvp.microsoft.com/en-us/PublicProfile/5002617), [ClearPeople](https://www.clearpeople.com), [@luismanez](https://twitter.com/luismanez)) |
## Version history
| Version | Date | Comments |
| ------- | ---------------- | --------------- |
| 1.0 | November 08, 2022 | Initial release |
---
## Minimal Path to Awesome
- Clone this repository
- Ensure that you are at the solution folder
- Edit the file _/src/webparts/dalleImageGenerator/Constants.ts_ and set your DALL-E API Key generated in the pre-requisites section
- in the command-line run:
- **npm install**
- **gulp serve**
## Features
This extension illustrates the following concepts:
- use of the DALL-E API
- use of PnPJS
## References
- [DALL-E 2 website](https://labs.openai.com/auth/signup)
- [Getting started with SharePoint Framework](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant)
- [Building for Microsoft teams](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/build-for-teams-overview)
- [Use Microsoft Graph in your solution](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/web-parts/get-started/using-microsoft-graph-apis)
- [Publish SharePoint Framework applications to the Marketplace](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/publish-to-marketplace-overview)
- [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp) - Guidance, tooling, samples and open-source controls for your Microsoft 365 development
## Help
We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.
If you're having issues building the solution, please run spfx doctor from within the solution folder to diagnose incompatibility issues with your environment.
You can try looking at issues related to this sample to see if anybody else is having the same issues.
You can also try looking at discussions related to this sample and see what the community is saying.
If you encounter any issues using this sample, create a new issue.
For questions regarding this sample, create a new question.
Finally, if you have an idea for improvement, make a suggestion.
## Disclaimer
THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.

BIN
samples/react-dall-e-image-generation/assets/react-dall-e-image-generation.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.4 MiB

18
samples/react-dall-e-image-generation/config/config.json Normal file
View File

@ -0,0 +1,18 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/config.2.0.schema.json",
"version": "2.0",
"bundles": {
"dalle-image-generator-web-part": {
"components": [
{
"entrypoint": "./lib/webparts/dalleImageGenerator/DalleImageGeneratorWebPart.js",
"manifest": "./src/webparts/dalleImageGenerator/DalleImageGeneratorWebPart.manifest.json"
}
]
}
},
"externals": {},
"localizedResources": {
"DalleImageGeneratorWebPartStrings": "lib/webparts/dalleImageGenerator/loc/{locale}.js"
}
}

7
samples/react-dall-e-image-generation/config/deploy-azure-storage.json Normal file
View File

@ -0,0 +1,7 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/deploy-azure-storage.schema.json",
"workingDir": "./release/assets/",
"account": "<!-- STORAGE ACCOUNT NAME -->",
"container": "react-dall-e-image-generation",
"accessKey": "<!-- ACCESS KEY -->"
}

40
samples/react-dall-e-image-generation/config/package-solution.json Normal file
View File

@ -0,0 +1,40 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json",
"solution": {
"name": "react-dall-e-image-generation-client-side-solution",
"id": "dd009cf4-7f8a-4811-9697-0771da80e3ad",
"version": "1.0.0.0",
"includeClientSideAssets": true,
"skipFeatureDeployment": true,
"isDomainIsolated": false,
"developer": {
"name": "",
"websiteUrl": "",
"privacyUrl": "",
"termsOfUseUrl": "",
"mpnId": "Undefined-1.15.2"
},
"metadata": {
"shortDescription": {
"default": "react-dall-e-image-generation description"
},
"longDescription": {
"default": "react-dall-e-image-generation description"
},
"screenshotPaths": [],
"videoUrl": "",
"categories": []
},
"features": [
{
"title": "react-dall-e-image-generation Feature",
"description": "The feature that activates elements of the react-dall-e-image-generation solution.",
"id": "a745537b-ef55-4ef4-9d30-3f00b0f129c8",
"version": "1.0.0.0"
}
]
},
"paths": {
"zippedPackage": "solution/react-dall-e-image-generation.sppkg"
}
}

6
samples/react-dall-e-image-generation/config/serve.json Normal file
View File

@ -0,0 +1,6 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/spfx-serve.schema.json",
"port": 4321,
"https": true,
"initialPage": "https://enter-your-SharePoint-site/_layouts/workbench.aspx"
}

4
samples/react-dall-e-image-generation/config/write-manifests.json Normal file
View File

@ -0,0 +1,4 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/spfx-build/write-manifests.schema.json",
"cdnBasePath": "<!-- PATH TO CDN -->"
}

16
samples/react-dall-e-image-generation/gulpfile.js vendored Normal file
View File

@ -0,0 +1,16 @@
'use strict';
const build = require('@microsoft/sp-build-web');
build.addSuppression(`Warning - [sass] The local CSS class 'ms-Grid' is not camelCase and will not be type-safe.`);
var getTasks = build.rig.getTasks;
build.rig.getTasks = function () {
var result = getTasks.call(build.rig);
result.set('serve', result.get('serve-deprecated'));
return result;
};
build.initialize(require('gulp'));

21160
samples/react-dall-e-image-generation/package-lock.json generated Normal file
View File

File diff suppressed because it is too large Load Diff

41
samples/react-dall-e-image-generation/package.json Normal file
View File

@ -0,0 +1,41 @@
{
"name": "react-dall-e-image-generation",
"version": "0.0.1",
"private": true,
"main": "lib/index.js",
"scripts": {
"build": "gulp bundle",
"clean": "gulp clean",
"test": "gulp test"
},
"dependencies": {
"@fluentui/react": "^8.100.0",
"@microsoft/sp-core-library": "1.15.2",
"@microsoft/sp-lodash-subset": "1.15.2",
"@microsoft/sp-office-ui-fabric-core": "1.15.2",
"@microsoft/sp-property-pane": "1.15.2",
"@microsoft/sp-webpart-base": "1.15.2",
"@pnp/logging": "^3.8.0",
"@pnp/sp": "^3.8.0",
"blob-util": "^2.0.2",
"office-ui-fabric-react": "7.185.7",
"react": "16.13.1",
"react-dom": "16.13.1",
"tslib": "2.3.1"
},
"devDependencies": {
"@microsoft/rush-stack-compiler-4.5": "0.2.2",
"@rushstack/eslint-config": "2.5.1",
"@microsoft/eslint-plugin-spfx": "1.15.2",
"@microsoft/eslint-config-spfx": "1.15.2",
"@microsoft/sp-build-web": "1.15.2",
"@types/webpack-env": "~1.15.2",
"ajv": "^6.12.5",
"gulp": "4.0.2",
"typescript": "4.5.5",
"@types/react": "16.9.51",
"@types/react-dom": "16.9.8",
"eslint-plugin-react-hooks": "4.3.0",
"@microsoft/sp-module-interfaces": "1.15.2"
}
}

1
samples/react-dall-e-image-generation/src/index.ts Normal file
View File

@ -0,0 +1 @@
// A file is required to be in the root of the /src directory by the TypeScript compiler

3
samples/react-dall-e-image-generation/src/webparts/dalleImageGenerator/Constants.ts Normal file
View File

@ -0,0 +1,3 @@
export default class Constants {
public static readonly DalleApiKey: string = '{YOUR_DALL-E-API-KEY}';
}

28
samples/react-dall-e-image-generation/src/webparts/dalleImageGenerator/DalleImageGeneratorWebPart.manifest.json Normal file
View File

@ -0,0 +1,28 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/spfx/client-side-web-part-manifest.schema.json",
"id": "b956287c-7b9b-4880-a514-ec9881e76518",
"alias": "DalleImageGeneratorWebPart",
"componentType": "WebPart",
// The "*" signifies that the version should be taken from the package.json
"version": "*",
"manifestVersion": 2,
// If true, the component can only be installed on sites where Custom Script is allowed.
// Components that allow authors to embed arbitrary script code should set this to true.
// https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f
"requiresCustomScript": false,
"supportedHosts": ["SharePointWebPart", "TeamsPersonalApp", "TeamsTab", "SharePointFullPage"],
"supportsThemeVariants": true,
"preconfiguredEntries": [{
"groupId": "5c03119e-3074-46fd-976b-c60198311f70", // Advanced
"group": { "default": "Advanced" },
"title": { "default": "DalleImageGenerator" },
"description": { "default": "DalleImageGenerator description" },
"officeFabricIconFontName": "Page",
"properties": {
"description": "DalleImageGenerator"
}
}]
}

113
samples/react-dall-e-image-generation/src/webparts/dalleImageGenerator/DalleImageGeneratorWebPart.ts Normal file
View File

@ -0,0 +1,113 @@
import * as React from 'react';
import * as ReactDom from 'react-dom';
import { Version } from '@microsoft/sp-core-library';
import {
IPropertyPaneConfiguration,
PropertyPaneTextField
} from '@microsoft/sp-property-pane';
import { BaseClientSideWebPart } from '@microsoft/sp-webpart-base';
import { IReadonlyTheme } from '@microsoft/sp-component-base';
import * as strings from 'DalleImageGeneratorWebPartStrings';
import DalleImageGenerator from './components/DalleImageGenerator';
import { IDalleImageGeneratorProps } from './components/IDalleImageGeneratorProps';
import { DalleImageGeneratorServiceKey, IDalleImageGeneratorService } from './services/DalleImageGeneratorService';
import { getSP } from './pnpjsConfig';
export interface IDalleImageGeneratorWebPartProps {
description: string;
}
export default class DalleImageGeneratorWebPart extends BaseClientSideWebPart<IDalleImageGeneratorWebPartProps> {
private _isDarkTheme: boolean = false;
private _environmentMessage: string = '';
private _dalleImageGeneratorService: IDalleImageGeneratorService;
public render(): void {
const element: React.ReactElement<IDalleImageGeneratorProps> = React.createElement(
DalleImageGenerator,
{
description: this.properties.description,
isDarkTheme: this._isDarkTheme,
environmentMessage: this._environmentMessage,
hasTeamsContext: !!this.context.sdks.microsoftTeams,
siteAbsoluteUrl: this.context.pageContext.site.absoluteUrl,
dalleImageGeneratorService: this._dalleImageGeneratorService
}
);
ReactDom.render(element, this.domElement);
}
protected onInit(): Promise<void> {
this._environmentMessage = this._getEnvironmentMessage();
return super
.onInit()
.then((_) => {
getSP(this.context);
const webpartScope = this.context.serviceScope.startNewChild();
webpartScope.finish();
return webpartScope;
})
.then((serviceScope) => {
this._dalleImageGeneratorService = serviceScope.consume(DalleImageGeneratorServiceKey);
});
}
private _getEnvironmentMessage(): string {
if (!!this.context.sdks.microsoftTeams) { // running in Teams
return this.context.isServedFromLocalhost ? strings.AppLocalEnvironmentTeams : strings.AppTeamsTabEnvironment;
}
return this.context.isServedFromLocalhost ? strings.AppLocalEnvironmentSharePoint : strings.AppSharePointEnvironment;
}
protected onThemeChanged(currentTheme: IReadonlyTheme | undefined): void {
if (!currentTheme) {
return;
}
this._isDarkTheme = !!currentTheme.isInverted;
const {
semanticColors
} = currentTheme;
if (semanticColors) {
this.domElement.style.setProperty('--bodyText', semanticColors.bodyText || null);
this.domElement.style.setProperty('--link', semanticColors.link || null);
this.domElement.style.setProperty('--linkHovered', semanticColors.linkHovered || null);
}
}
protected onDispose(): void {
ReactDom.unmountComponentAtNode(this.domElement);
}
protected get dataVersion(): Version {
return Version.parse('1.0');
}
protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
return {
pages: [
{
header: {
description: strings.PropertyPaneDescription
},
groups: [
{
groupName: strings.BasicGroupName,
groupFields: [
PropertyPaneTextField('description', {
label: strings.DescriptionFieldLabel
})
]
}
]
}
]
};
}
}

BIN
samples/react-dall-e-image-generation/src/webparts/dalleImageGenerator/assets/welcome-dark.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

BIN
samples/react-dall-e-image-generation/src/webparts/dalleImageGenerator/assets/welcome-light.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

34
samples/react-dall-e-image-generation/src/webparts/dalleImageGenerator/components/DalleImageGenerator.module.scss Normal file
View File

@ -0,0 +1,34 @@
@import '~office-ui-fabric-react/dist/sass/References.scss';
.dalleImageGenerator {
overflow: hidden;
padding: 1em;
color: "[theme:bodyText, default: #323130]";
color: var(--bodyText);
&.teams {
font-family: $ms-font-family-fallbacks;
}
}
.welcome {
text-align: center;
}
.welcomeImage {
width: 100%;
max-width: 420px;
}
.links {
a {
text-decoration: none;
color: "[theme:link, default:#03787c]";
color: var(--link); // note: CSS Custom Properties support is limited to modern browsers only
&:hover {
text-decoration: underline;
color: "[theme:linkHovered, default: #014446]";
color: var(--linkHovered); // note: CSS Custom Properties support is limited to modern browsers only
}
}
}

122
samples/react-dall-e-image-generation/src/webparts/dalleImageGenerator/components/DalleImageGenerator.tsx Normal file
View File

@ -0,0 +1,122 @@
import * as React from 'react';
import { IDalleImageGeneratorProps } from './IDalleImageGeneratorProps';
import { IDalleImageGeneratorState } from './IDalleImageGeneratorState';
import { imageGenerationAllowedSizes } from '../models/IGeneratedImagesRequest';
import { IGeneratedImagesResponse } from '../models/IGeneratedImagesResponse';
import { Stack, Slider } from '@fluentui/react';
import { PrimaryButton } from '@fluentui/react/lib/Button';
import { TextField } from '@fluentui/react/lib/TextField';
import { ChoiceGroup, IChoiceGroupOption } from '@fluentui/react/lib/ChoiceGroup';
import { Image } from '@fluentui/react/lib/Image';
import {
Link,
MessageBar,
MessageBarType,
} from '@fluentui/react';
import { base64StringToBlob } from 'blob-util';
export default class DalleImageGenerator extends React.Component<IDalleImageGeneratorProps, IDalleImageGeneratorState> {
constructor(props: IDalleImageGeneratorProps) {
super(props);
this.state = {
images: [],
imageDescription: '',
imageSize: '256x256',
numberOfImages: 3,
imageSavedInfo: '',
actionMessageInfo: 'Fill the form and generate some images...'
};
this._sendImagesGenerationRequest = this._sendImagesGenerationRequest.bind(this);
}
public render(): React.ReactElement<IDalleImageGeneratorProps> {
const options: IChoiceGroupOption[] = [
{ key: '256x256', text: '256x256' },
{ key: '512x512', text: '512x512' },
{ key: '1024x1024', text: '1024x1024'}
];
let images = undefined;
if (this.state.images && this.state.images.length > 0) {
images = this.state.images.map((imageAsBase64, index) => {
const blob = base64StringToBlob(imageAsBase64);
const url = URL.createObjectURL(blob);
return <Image key={index} src={url} alt={this.state.imageDescription} onClick={async () => {
const imageUrl: string = await this.props.dalleImageGeneratorService.saveImageToSiteAssetsLibrary(`${this.state.imageDescription}_${index}.png`, blob);
this.setState({
imageSavedInfo: this.props.siteAbsoluteUrl + imageUrl
});
}} />
});
}
let imageSavedInfo = undefined;
if (this.state.imageSavedInfo) {
imageSavedInfo = <MessageBar messageBarType={MessageBarType.success}>Image saved!
<Link href={this.state.imageSavedInfo} target="_blank" underline>
{this.state.imageSavedInfo}
</Link>
</MessageBar>
}
return (
<Stack>
<TextField
label="Image description (be creative!)"
multiline
rows={3}
onChange={(event: React.FormEvent<HTMLInputElement | HTMLTextAreaElement>, newValue?: string) => { this.setState({imageDescription: newValue})}}
/>
<Slider
label="Number of images to generate?"
min={1}
max={10}
step={1}
defaultValue={3}
showValue
snapToStep
onChange={(value: number, range?: [number, number], event?: React.MouseEvent | React.TouchEvent | MouseEvent | TouchEvent | React.KeyboardEvent) => { this.setState({numberOfImages: value})}}
/>
<ChoiceGroup
selectedKey={this.state.imageSize}
options={options}
onChange={(ev: React.SyntheticEvent<HTMLElement>, option: IChoiceGroupOption) => { this.setState({imageSize: option.key}) }}
label="Size" />;
<PrimaryButton
text="Generate Images with DALL-E"
onClick={this._sendImagesGenerationRequest} />
<Stack tokens={{ padding: 10, childrenGap: 10 }}>
<MessageBar>{this.state.actionMessageInfo}</MessageBar>
{imageSavedInfo}
{images}
</Stack>
</Stack>
);
}
private async _sendImagesGenerationRequest(): Promise<void> {
console.log(this.state);
this.setState({
actionMessageInfo: 'Generating images from DALL-E...'
})
const generationsResponse: IGeneratedImagesResponse = await this.props.dalleImageGeneratorService.generateImages(
this.state.imageDescription,
this.state.numberOfImages,
this.state.imageSize as imageGenerationAllowedSizes);
console.log(generationsResponse);
this.setState({
actionMessageInfo: 'Click on the image to save it into the site documents library',
images: generationsResponse.data.map(i => i.b64_json)
});
}
}

10
samples/react-dall-e-image-generation/src/webparts/dalleImageGenerator/components/IDalleImageGeneratorProps.ts Normal file
View File

@ -0,0 +1,10 @@
import { IDalleImageGeneratorService } from "../services/DalleImageGeneratorService";
export interface IDalleImageGeneratorProps {
description: string;
isDarkTheme: boolean;
environmentMessage: string;
hasTeamsContext: boolean;
siteAbsoluteUrl: string;
dalleImageGeneratorService: IDalleImageGeneratorService;
}

9
samples/react-dall-e-image-generation/src/webparts/dalleImageGenerator/components/IDalleImageGeneratorState.ts Normal file
View File

@ -0,0 +1,9 @@
export interface IDalleImageGeneratorState {
imageDescription: string;
numberOfImages: number;
imageSize: string;
images: string[];
imageSavedInfo: string;
actionMessageInfo: string;
}

11
samples/react-dall-e-image-generation/src/webparts/dalleImageGenerator/loc/en-us.js vendored Normal file
View File

@ -0,0 +1,11 @@
define([], function() {
return {
"PropertyPaneDescription": "Description",
"BasicGroupName": "Group Name",
"DescriptionFieldLabel": "Description Field",
"AppLocalEnvironmentSharePoint": "The app is running on your local environment as SharePoint web part",
"AppLocalEnvironmentTeams": "The app is running on your local environment as Microsoft Teams app",
"AppSharePointEnvironment": "The app is running on SharePoint page",
"AppTeamsTabEnvironment": "The app is running in Microsoft Teams"
}
});

14
samples/react-dall-e-image-generation/src/webparts/dalleImageGenerator/loc/mystrings.d.ts vendored Normal file
View File

@ -0,0 +1,14 @@
declare interface IDalleImageGeneratorWebPartStrings {
PropertyPaneDescription: string;
BasicGroupName: string;
DescriptionFieldLabel: string;
AppLocalEnvironmentSharePoint: string;
AppLocalEnvironmentTeams: string;
AppSharePointEnvironment: string;
AppTeamsTabEnvironment: string;
}
declare module 'DalleImageGeneratorWebPartStrings' {
const strings: IDalleImageGeneratorWebPartStrings;
export = strings;
}

3
samples/react-dall-e-image-generation/src/webparts/dalleImageGenerator/models/IGeneratedImageInfo.ts Normal file
View File

@ -0,0 +1,3 @@
export interface IGeneratedImageInfo {
b64_json: string;
}

33
samples/react-dall-e-image-generation/src/webparts/dalleImageGenerator/models/IGeneratedImagesRequest.ts Normal file
View File

@ -0,0 +1,33 @@
export type imageGenerationAllowedSizes = "256x256" | "512x512" | "1024x1024";
export interface IGeneratedImagesRequest {
readonly prompt: string;
readonly n: number;
readonly size: imageGenerationAllowedSizes;
toJson(): string;
}
export default class GeneratedImagesRequest implements IGeneratedImagesRequest {
readonly prompt: string;
readonly n: number;
readonly size: imageGenerationAllowedSizes;
readonly response_format: string;
constructor(
imageDescription: string,
numberOfImagesToGenerate: number,
imageSize: imageGenerationAllowedSizes) {
if (numberOfImagesToGenerate > 10) throw Error("Cannot generate more than 10 images per request");
this.prompt = imageDescription;
this.n = numberOfImagesToGenerate;
this.size = imageSize;
this.response_format = 'b64_json';
}
public toJson(): string {
return JSON.stringify(this);
}
}

7
samples/react-dall-e-image-generation/src/webparts/dalleImageGenerator/models/IGeneratedImagesResponse.ts Normal file
View File

@ -0,0 +1,7 @@
import { IGeneratedImageInfo } from "./IGeneratedImageInfo";
export interface IGeneratedImagesResponse {
created: number;
data: IGeneratedImageInfo[];
}

21
samples/react-dall-e-image-generation/src/webparts/dalleImageGenerator/pnpjsConfig.ts Normal file
View File

@ -0,0 +1,21 @@
import { WebPartContext } from "@microsoft/sp-webpart-base";
// import pnp and pnp logging system
import { spfi, SPFI, SPFx } from "@pnp/sp";
import { LogLevel, PnPLogging } from "@pnp/logging";
import "@pnp/sp/webs";
import "@pnp/sp/lists";
import "@pnp/sp/items";
import "@pnp/sp/batching";
// eslint-disable-next-line no-var
var _sp: SPFI = null;
export const getSP = (context?: WebPartContext): SPFI => {
if (context) {
//You must add the @pnp/logging package to include the PnPLogging behavior it is no longer a peer dependency
// The LogLevel set's at what level a message will be written to the console
_sp = spfi().using(SPFx(context)).using(PnPLogging(LogLevel.Warning));
}
return _sp;
};

70
samples/react-dall-e-image-generation/src/webparts/dalleImageGenerator/services/DalleImageGeneratorService.ts Normal file
View File

@ -0,0 +1,70 @@
import GeneratedImagesRequest, { IGeneratedImagesRequest, imageGenerationAllowedSizes } from "../models/IGeneratedImagesRequest";
import { IGeneratedImagesResponse } from "../models/IGeneratedImagesResponse";
import Constants from '../Constants';
import { ServiceKey, ServiceScope } from "@microsoft/sp-core-library";
import { HttpClient, IHttpClientOptions, HttpClientResponse } from "@microsoft/sp-http";
import { getSP } from "../pnpjsConfig";
import { SPFI } from "@pnp/sp";
import "@pnp/sp/lists";
import "@pnp/sp/folders/list";
import "@pnp/sp/files/folder";
export interface IDalleImageGeneratorService {
generateImages(
imageDescription: string,
numberOfImagesToGenerate: number,
imageSize: imageGenerationAllowedSizes): Promise<IGeneratedImagesResponse>;
saveImageToSiteAssetsLibrary(imageName: string, image: Blob): Promise<string>;
}
export default class DalleImageGeneratorService implements IDalleImageGeneratorService {
private _httpClient: HttpClient;
private _sp: SPFI;
constructor(serviceScope:ServiceScope) {
serviceScope.whenFinished(async () => {
this._httpClient = serviceScope.consume(HttpClient.serviceKey);
});
this._sp = getSP();
}
public async saveImageToSiteAssetsLibrary(imageName: string, image: Blob): Promise<string> {
const imageFileToSharePoint = await this._sp.web.lists.getByTitle("Documents").rootFolder.files.addChunked(imageName, image, undefined, true);
const item = await imageFileToSharePoint.file.getItem<{ Id: number, Title: string, FileRef: string }>("Id", "Title", "FileRef");
return item.FileRef;
}
public async generateImages(
imageDescription: string,
numberOfImagesToGenerate: number,
imageSize: imageGenerationAllowedSizes): Promise<IGeneratedImagesResponse> {
const generateImagesRequest: IGeneratedImagesRequest =
new GeneratedImagesRequest(imageDescription, numberOfImagesToGenerate, imageSize);
const requestHeaders: Headers = new Headers();
requestHeaders.append('Content-type', 'application/json');
requestHeaders.append('Authorization', `Bearer ${Constants.DalleApiKey}`);
const httpClientOptions: IHttpClientOptions = {
body: generateImagesRequest.toJson(),
headers: requestHeaders
};
const response: HttpClientResponse =
await this._httpClient.post(
"https://api.openai.com/v1/images/generations",
HttpClient.configurations.v1,
httpClientOptions);
const generateImagesResponse: IGeneratedImagesResponse = await response.json();
return generateImagesResponse;
}
}
export const DalleImageGeneratorServiceKey = ServiceKey.create<IDalleImageGeneratorService>("pnp:dalleImageGeneratorService", DalleImageGeneratorService);

BIN
samples/react-dall-e-image-generation/teams/b956287c-7b9b-4880-a514-ec9881e76518_color.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 10 KiB

BIN
samples/react-dall-e-image-generation/teams/b956287c-7b9b-4880-a514-ec9881e76518_outline.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 542 B

37
samples/react-dall-e-image-generation/tsconfig.json Normal file
View File

@ -0,0 +1,37 @@
{
"extends": "./node_modules/@microsoft/rush-stack-compiler-4.5/includes/tsconfig-web.json",
"compilerOptions": {
"target": "es5",
"forceConsistentCasingInFileNames": true,
"module": "esnext",
"moduleResolution": "node",
"jsx": "react",
"declaration": true,
"sourceMap": true,
"experimentalDecorators": true,
"skipLibCheck": true,
"outDir": "lib",
"inlineSources": false,
"strictNullChecks": false,
"noUnusedLocals": false,
"noImplicitAny": true,
"typeRoots": [
"./node_modules/@types",
"./node_modules/@microsoft"
],
"types": [
"webpack-env"
],
"lib": [
"es5",
"dom",
"es2015.collection",
"es2015.promise"
]
},
"include": [
"src/**/*.ts",
"src/**/*.tsx"
]
}

18
samples/react-kiota-custom-api-client/TeamifiedApi/appsettings.Development.json Normal file
View File

@ -0,0 +1,18 @@
{
"AzureAd": {
"Instance": "https://login.microsoftonline.com/",
"ClientId": "5630c940-5b6a-4f6e-98a4-5a14f6dda313",
"TenantId": "f1350198-f81d-46fa-91e7-1535ce306b59",
"ClientSecret": "Lsa8Q~~iRDrIUCaN5sW4zcwpASQS75j_ION.GcjP"
},
"MicrosoftGraph": {
"BaseUrl": "https://graph.microsoft.com/v1.0",
"Scopes": "https://graph.microsoft.com/.default"
},
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft.AspNetCore": "Warning"
}
}
}

21158
samples/react-kiota-custom-api-client/teamified-client/package-lock.json generated Normal file
View File

File diff suppressed because it is too large Load Diff